# @capgo/capacitor-keep-awake 中文文档

规范地址：https://npmcn.com/package/%40capgo/capacitor-keep-awake/

版本：8\.1\.20
npm 元数据更新时间：2026-10-15T05:15:20.956Z
中文译文更新时间：2026-11-09T03:37:58.663Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40capgo/capacitor-keep-awake
原文对照：https://npmcn.com/package/%40capgo/capacitor-keep-awake/?lang=original
项目主页：https://capgo.app/docs/plugins/keep-awake/
源码仓库：https://github.com/Cap-go/capacitor-keep-awake

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：55.6 kB，24 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2025-12-16T17:08:55.248Z
- 最新版本发布：2026-10-15T05:15:20.434Z
- 近 30 天下载量：45247（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

防止设备屏幕变暗或入睡.

## 安装

```sh
npm install @capgo/capacitor-keep-awake
```

也可以使用：`pnpm add @capgo/capacitor-keep-awake`、`yarn add @capgo/capacitor-keep-awake`、`bun add @capgo/capacitor-keep-awake`

## README

# 电容器保持醒

在用户在您的 Capacitor app 中观看、读取、导航或遵循一个食谱时, 保持屏幕上, 然后让它再次入睡.

[![Capgo - Build Capacitor apps with AI, ship updates instantly](https://capgo.app/readme-banner.svg?repo=Cap-go/capacitor-keep-awake)](https://capgo.app/?ref=plugin_keep_awake)

**队长**:在几分钟内将修正推给您的 Capacitor 用户,在没有Mac的情况下构建已签名的iOS和Android apps,并在一击中回滚.

## [\*免费开始\*](https://capgo.app/register/?ref=plugin_keep_awake)

14天无限自由审判. 不需要信用卡

> 🤖 **建筑与AI编码代理?** 安装 [Capgo 技能](https://capgo.app/skills/?ref=plugin_keep_awake) 所以克劳德代码,代码,光标,副驾驶,或双子座CLI知道如何安装和使用 `@capgo/capacitor-keep-awake` 在您的电容应用程序中: `npx skills add Cap-go/capgo-skills`。然后问你的经纪人: _加入@capgo/capor-keep-wake到我的Capacitor应用上并把它接上"_ [代理设置指南](https://capgo.app/agents/?ref=plugin_keep_awake) • 妇女 [主机磁共振](https://capgo.app/docs/ai/mcp/?ref=plugin_keep_awake)

![@capgo/capacitor-keep-awake for Capacitor apps](https://raw.githubusercontent.com/Cap-go/capacitor-keep-awake/main/assets/github-social-preview.png)

## 主要特点

-   **继续清醒**数字 : `keepAwake()` 停止屏幕变暗或锁定.
-   **允许入睡**数字 : `allowSleep()` 恢复正常的超时.
-   **状态**数字 : `isKeptAwake()` 报告是否保持清醒是活跃的.
-   **支持检查**数字 : `isSupported()` 告诉你,如果当前的平台可以做到这一点.
-   **平台**: iOS,Android和Web. 互联网档案馆的存檔,存档日期2013-12-02. Web使用浏览器支持它的屏幕Wake Lock API.

## 为什么Capacitor保持清醒?

很简单, **免费**,以及 **轻型** 屏幕提醒锁插件 :

-   **保持屏幕显示** - 防止装置变暗或入睡
-   **状态检查** - 查询当前唤醒锁状态
-   **平台支持** - 检查当前平台是否有醒钟锁
-   **通用兼容性** - 跨iOS、Android和网络工作
-   **现代软件包管理** - 支持Swift软件包管理器(SPM)和CocoaPods(SPM-为Capacitor 8准备)
-   **零依赖关系** - 最小的脚印,没有出血

适合视频播放器,导航应用程序,游戏,演示,以及任何需要屏幕保持的应用程序.

## 文档

这里有最完整的医生: [https://capgo.app/docs/plugins/keep-ake/ 页面存档备份,存于互联网档案馆](https://capgo.app/docs/plugins/keep-awake/)

## 兼容性

| 插件版本 | 电容兼容性 | 维护 |
| --- | --- | --- |
| 联合国 | 联合国 | ✅ |
| 页:1 | 页:1 | 应要求 |
| 页:1 | 页:1 | ❌ |
| 页:1 | 页:1 | ❌ |

> **说明:** 此插件的主要版本沿用了Capacitor的主要版本. 使用匹配您的 Capacitor 安装的版本( 如 Capacitor 8 的插件 v8) 。 只有最新的主要版本得到积极维护.

## 安装

您可以使用我们的 AI 辅助设置安装插件 。 使用以下命令将 Capgo 技能添加到您的 AI 工具 :

```bash
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins
```

然后使用下列提示:

```text
Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-keep-awake` plugin in my project.
```

如果您更喜欢手动设置,请通过运行以下命令来安装插件,并遵循下面的平台特定指令:

```bash
npm install @capgo/capacitor-keep-awake
npx cap sync
```

## iOS系统

工作在盒子内。 用途 `UIApplication.shared.isIdleTimerDisabled` 控制屏幕睡眠.

## 机器人

工作在盒子内。 用途 `WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON` 旗帜。 无需权限 .

## 网页

在支持Screen Wake Lock API的现代浏览器中工作. 打电话 `isSupported()` 首先检查当前浏览器是否有醒钟锁.

## API 密码

-   [`keepAwake()`](https://npmcn.com/package/%40capgo/capacitor-keep-awake/#readme-keepawake)
-   [`allowSleep()`](https://npmcn.com/package/%40capgo/capacitor-keep-awake/#readme-allowsleep)
-   [`isSupported()`](https://npmcn.com/package/%40capgo/capacitor-keep-awake/#readme-issupported)
-   [`isKeptAwake()`](https://npmcn.com/package/%40capgo/capacitor-keep-awake/#readme-iskeptawake)
-   [`getPluginVersion()`](https://npmcn.com/package/%40capgo/capacitor-keep-awake/#readme-getpluginversion)
-   [接口](https://npmcn.com/package/%40capgo/capacitor-keep-awake/#readme-interfaces)

Capacitor 保持醒悟插件,用于防止设备屏幕变暗/沉睡.

### 保持清醒( )

```typescript
keepAwake() => Promise<void>
```

防止设备暗化屏幕.

**自:** 1.0.0 (单位:千美元)

* * *

### 允许睡眠( C)

```typescript
allowSleep() => Promise<void>
```

允许设备暗化屏幕(无法保持清醒).

**自:** 1.0.0 (单位:千美元)

* * *

### 已支持 ()

```typescript
isSupported() => Promise<IsSupportedResult>
```

检查当前平台是否支持保持清醒特性 .

**回返情况:** `Promise<[IsSupportedResult](https://npmcn.com/package/%40capgo/capacitor-keep-awake/#readme-issupportedresult)>`

**自:** 1.0.0 (单位:千美元)

* * *

### 是 KeptAwake () 语句

```typescript
isKeptAwake() => Promise<IsKeptAwakeResult>
```

检查设备是否被保持清醒 .

**回返情况:** `Promise<[IsKeptAwakeResult](https://npmcn.com/package/%40capgo/capacitor-keep-awake/#readme-iskeptawakeresult)>`

**自:** 1.0.0 (单位:千美元)

* * *

### 获取 PluginVersion ()

```typescript
getPluginVersion() => Promise<{ version: string; }>
```

获取本地 Capacitor 插件版本 .

**回返情况:** `Promise<{ version: string; }>`

**自:** 1.0.0 (单位:千美元)

* * *

### 接口

#### 支持的结果

支持方法的结果.

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`isSupported`** | `boolean` | 是否保持清醒在当前平台上得到支持 . | 1.0.0 (单位:千美元) |

#### 觉醒复出

KeptAwake( ) 方法的结果 .

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`isKeptAwake`** | `boolean` | 设备是否被保持清醒 . | 1.0.0 (单位:千美元) |

## 常见问题

### @capgo/capacitor-keep-awake 是什么？

防止设备屏幕变暗或入睡\.

### 如何安装 @capgo/capacitor-keep-awake？

在项目目录运行 npm install @capgo/capacitor-keep-awake，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@capacitor/core（\>=8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @capgo/capacitor-keep-awake 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @capgo/capacitor-keep-awake 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @capgo/capacitor-keep-awake 可以商用吗？

@capgo/capacitor-keep-awake 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @capgo/capacitor-keep-awake 的下载量有多少？

根据 npm 官方下载统计，@capgo/capacitor-keep-awake 在 2026/10/09 – 2026/11/07 这 30 天内被下载 45,247 次，日均约 1,508 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @capgo/capacitor-keep-awake 还在维护吗？

最新版本 8\.1\.20 发布于 2026/10/15（25 天前）；至今共发布 20 个版本，其中过去 12 个月发布了 20 个；首次发布于 2025/12/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。