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

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

版本：0\.1\.3
npm 元数据更新时间：2026-10-17T05:17:30.490Z
中文译文更新时间：2026-11-09T05:02:56.278Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：57.3 kB，33 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2026-07-07T06:21:11.263Z
- 最新版本发布：2026-10-17T05:17:30.159Z
- 近 30 天下载量：10390（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 5 个）

## 中文简介

控制器插件可以使屏幕在Android,iOS,和Web上保持清醒.

## 安装

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

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

## README

# 电容保持醒悟插件

保持屏幕清醒的电容插件.

[![Ship a fix in one command with Capawesome Cloud Live Updates, no store review](https://capawesome.io/assets/banners/cloud-ship-a-fix-in-one-command.png)](https://capawesome.io/)

## 特征

-   🌙 **继续清醒**:防止屏幕变暗或关闭.
-   💤 **允许入睡**:随时恢复默认屏幕睡眠行为.
-   🔍 **状态**:读取当前屏幕是否保持清醒.
-   🌐 **跨平台**:支持Android,iOS和Web(通过Screen Wake Lock API).
-   🤝 **兼容性**: 与 [电池](https://capawesome.io/docs/sdks/capacitor/battery/), (中文(简体) ), [屏幕亮度](https://capawesome.io/docs/sdks/capacitor/screen-brightness/) 财务报告和审定财务报表 [屏幕方向](https://capawesome.io/docs/sdks/capacitor/screen-orientation/) 插件 .
-   📦 **可可花和SPM**:支持CocoaPods和Swift软件包管理器用于iOS.
-   🔁 **最新数据**:总是支持最新的Capacitor版本.

缺少一个功能? 刚刚 [打开一个问题](https://github.com/capawesome-team/capacitor-plugins/issues) 我们看看!

## 使用大小写

Keep Awake插件一般在屏幕必须保持可见而不用户交互时使用,例如:

-   **媒体播放**:在用户观看视频或跟随内容时保持屏蔽.
-   **导航和跟踪**: 防止在转弯导航或解决跟踪过程中显示关闭.
-   **无手读取**:在用户手忙脚乱时,保持食谱,工作表音乐,或分步指示的可见.
-   **挂板和站台**:显示活的数据或演示文稿,而不显示屏幕变暗或睡眠.

## 兼容性

| 插件版本 | 电容版本 | 状态 |
| --- | --- | --- |
| 0.x.x (中文(简体) ) | \>=8.x.x | 积极支持 |

## 安装

你可以用我们的 **AI 辅助设置** 以安装插件. 添加数据 [超级技能](https://github.com/capawesome-team/skills) 至您的 AI 工具,使用以下命令:

```bash
npx skills add capawesome-team/skills --skill capacitor-plugins
```

然后使用下列提示:

```
 Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-keep-awake` plugin in my project.
```

如果你喜欢 **手动设置**,通过运行下列命令来安装插件:

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

此插件可用于 **机器人**, (中文(简体) ), **iOS系统** 财务报告和审定财务报表 **网页**。不需要额外的权限或配置.

## 配置

此插件不需要配置 .

## 使用量

以下例子显示如何保持屏幕保持清醒,允许它再次入睡,检查它目前是否保持清醒,并检查功能是否可用.

### 让屏幕保持清醒

防止屏幕变暗或关闭. 银幕一直保持清醒,直到 `allowSleep(...)` 调用或重新启动应用程序。 这只影响您的应用程序, 而不是一个全系统的设置 :

```typescript
import { KeepAwake } from '@capawesome/capacitor-keep-awake';

const keepAwake = async () => {
  await KeepAwake.keepAwake();
};
```

### 让屏幕再次入睡

随时恢复默认屏幕睡眠行为 :

```typescript
import { KeepAwake } from '@capawesome/capacitor-keep-awake';

const allowSleep = async () => {
  await KeepAwake.allowSleep();
};
```

### 检查屏幕是否保持清醒

读取当前屏幕是否保持清醒 :

```typescript
import { KeepAwake } from '@capawesome/capacitor-keep-awake';

const isKeptAwake = async () => {
  const { keptAwake } = await KeepAwake.isKeptAwake();
  return keptAwake;
};
```

### 检查该特性是否可用

在网络上,让屏幕保持清醒取决于浏览器是否支持 [屏幕唤醒锁定 API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API)在Android和iOS上,它总是返回 `true`数字 :

```typescript
import { KeepAwake } from '@capawesome/capacitor-keep-awake';

const isAvailable = async () => {
  const { available } = await KeepAwake.isAvailable();
  return available;
};
```

## API 密码

-   [`allowSleep()`](https://npmcn.com/package/%40capawesome/capacitor-keep-awake/#readme-allowsleep)
-   [`isAvailable()`](https://npmcn.com/package/%40capawesome/capacitor-keep-awake/#readme-isavailable)
-   [`isKeptAwake()`](https://npmcn.com/package/%40capawesome/capacitor-keep-awake/#readme-iskeptawake)
-   [`keepAwake()`](https://npmcn.com/package/%40capawesome/capacitor-keep-awake/#readme-keepawake)
-   [接口](https://npmcn.com/package/%40capawesome/capacitor-keep-awake/#readme-interfaces)

### 允许睡眠( C)

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

允许屏幕变暗或再次关闭 .

这扭转了 `keepAwake(...)`。 。 。 .

仅在Android,iOS和Web上提供.

**自:** 0.1.0 (中文(简体) )

* * *

### 易读 ()

```typescript
isAvailable() => Promise<IsAvailableResult>
```

检查此设备是否可保持屏幕清醒 .

在 Web 上,这取决于浏览器是否支持 [屏幕唤醒锁定 API](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API)。 。 。 . 在Android和iOS上,它总是返回 `true`。 。 。 .

仅在Android,iOS和Web上提供.

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

**自:** 0.1.0 (中文(简体) )

* * *

### 是 KeptAwake () 语句

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

检查屏幕是否保持了清醒 .

仅在Android,iOS和Web上提供.

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

**自:** 0.1.0 (中文(简体) )

* * *

### 保持清醒( )

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

通过防止屏幕变暗或关机,保持屏幕清醒.

银幕一直保持清醒,直到 `allowSleep(...)` 被调用,或者该应用程序是 重新启动 。 此设置只影响您的应用, 而不是整个系统 .

仅在Android,iOS和Web上提供.

**自:** 0.1.0 (中文(简体) )

* * *

### 接口

#### 易伤性结果

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`available`** | `boolean` | 此设备是否可保持屏幕清醒 . | 0.1.0 (中文(简体) ) |

#### 觉醒复出

| Prop | 类型 | 说明 | 自兹 |
| --- | --- | --- | --- |
| **`keptAwake`** | `boolean` | 屏幕目前是否保持清醒 . | 0.1.0 (中文(简体) ) |

## 行为

使用此插件时记住以下内容 :

-   **App 范围**:让屏幕保持清醒只会影响你的应用,而不是全系统的设定.
-   **状态重设**:屏幕只保持清醒,直到 `allowSleep(...)` 调用或重新启动应用程序.
-   **网络自动发布**: 在网络上,基础 [屏幕醒锁](https://developer.mozilla.org/en-US/docs/Web/API/Screen_Wake_Lock_API) 当标签被隐藏时(例如,当用户切换标签或最小化窗口时),浏览器会自动释放。 插件在标签再次可见时自动重新获得醒钟锁, 只要 `allowSleep(...)` 在此期间,没有发出呼吁.

## 财务问题

### 此插件与其他类似插件有何不同?

它使Android,iOS上的屏幕和Web从一个完全输入了API的屏幕上保持清醒,并让你检查功能是否可用以及屏幕目前是否保持清醒. 在网络上它使用"Screen Wake Lock API",当隐藏的标签再次被看到时,它会自动地重新获得锁,因此各个平台的行为都是可预测的. 它不需要权限或配置,并被相对于最新的Capacitor版本积极维护.

### 此插件支持哪个平台 ?

该插件支持Android,iOS和Web. 在网络上,它依赖于Screen Wake Lock API,所以可用性取决于浏览器. 您可以在运行时与 `isAvailable()` 方法,总是返回 `true` (原始内容存档于2019-10-12). Android and iOS.

### 让屏幕保持清醒会影响其他应用吗?

不,让屏幕保持清醒只会影响你的应用 而不是整个系统 一旦用户离开你的应用程序,设备的默认屏幕睡眠行为再次被应用.

### 屏风多久才醒?

银幕一直保持清醒,直到 `allowSleep(...)` 调用或重新启动应用程序。 设置不会在应用程序重新启动时持续 .

### 为什么屏幕在切换分页后又会睡在网络上?

在Web上,浏览器在标签被隐藏时会自动释放下方的醒钟锁,例如当用户切换标签或将窗口最小化时. 插件在标签再次可见时自动重新获得醒钟锁, 只要 `allowSleep(...)` 在此期间,没有发出呼吁。 见 [行为](https://npmcn.com/package/%40capawesome/capacitor-keep-awake/#readme-behavior) 详细情况.

### 我需要任何权限或配置吗?

不, 插件不需要任何平台的权限或配置 。 简单装好然后打电话 `keepAwake()`。 。 。 .

### 我能用这个插件吗? 有Ionic、React、Vue或Angular?

是的,插件是框架不可知的。 它在任意网络框架的Capacitor app中工作,包括有Angular,React,或Vue的Ionic,以及平版JavaScript等项目.

## 相关插件

-   [电池](https://capawesome.io/docs/sdks/capacitor/battery/): 获取设备的电池信息.
-   [屏幕亮度](https://capawesome.io/docs/sdks/capacitor/screen-brightness/):读取并控制屏幕亮度.
-   [屏幕方向](https://capawesome.io/docs/sdks/capacitor/screen-orientation/):锁定并解锁屏幕取向.

## 通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 [《卡帕索克通讯》](https://cloud.capawesome.io/newsletter/)。 。 。 .

## 更改日志

见 [变动情况](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/keep-awake/CHANGELOG.md)。 。 。 .

## 许可证

见 [自由主义](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/keep-awake/LICENSE)。 。 。 .

## 常见问题

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

控制器插件可以使屏幕在Android,iOS,和Web上保持清醒\.

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

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

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

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

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

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

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

@capawesome/capacitor-keep-awake 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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