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

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

版本：8\.0\.1
npm 元数据更新时间：2026-10-23T21:47:52.498Z
中文译文更新时间：2026-11-09T01:42:57.608Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：38 kB，25 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2020-10-07T07:40:06.346Z
- 最新版本发布：2026-04-16T12:53:40.472Z
- 近 30 天下载量：807702（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 2 个）

## 中文简介

阻止你的屏幕睡觉!

## 安装

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

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

## README

  
![](https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png)

### 保持清醒

**`@capacitor-community/keep-awake`**

QQ Capacitor 插件来防止设备暗淡或锁定屏幕.

![](https://img.shields.io/maintenance/yes/2026?style=flat-square) [![](https://img.shields.io/github/actions/workflow/status/capacitor-community/keep-awake/ci.yml?branch=master&style=flat-square)](https://github.com/capacitor-community/keep-awake/actions?query=workflow%3A%22CI%22) [![](https://img.shields.io/npm/l/@capacitor-community/keep-awake?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/keep-awake)  
[![](https://img.shields.io/npm/dw/@capacitor-community/keep-awake?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/keep-awake) [![](https://img.shields.io/npm/v/@capacitor-community/keep-awake?style=flat-square)](https://www.npmjs.com/package/@capacitor-community/keep-awake) [![](https://img.shields.io/badge/all%20contributors-2-orange?style=flat-square)](https://npmcn.com/package/%40capacitor-community/keep-awake/#readme-contributors-)

## 维护者

| 维护者 | GitHub 图像 | 社会 |
| --- | --- | --- |
| 凯文·布斯滕 | [树苗](https://github.com/kevinboosten) | [@克文布斯腾](https://twitter.com/kevinboosten) |
| 罗宾·根兹 | [抢劫](https://github.com/robingenz) | [@robin genz (中文(简体) )](https://twitter.com/robin_genz) |

## 安装

```shell
npm install @capacitor-community/keep-awake
npx cap sync
```

## 配置

此插件不需要配置 .

## 演示

一个实例可以在实例应用文件夹中找到.

## 使用量

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

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

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

const isSupported = async () => {
  const result = await KeepAwake.isSupported();
  return result.isSupported;
};

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

## API 密码

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

### 保持清醒( )

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

防止设备暗化屏幕.

* * *

### 允许睡眠( C)

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

允许设备淡出屏幕 .

* * *

### 已支持 ()

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

是否保持清醒得到支持 .

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

* * *

### 是 KeptAwake () 语句

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

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

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

* * *

### 接口

#### 支持的结果

| Prop | 类型 |
| --- | --- |
| **`isSupported`** | `boolean` |

#### 觉醒复出

| Prop | 类型 |
| --- | --- |
| **`isKeptAwake`** | `boolean` |

## 更改日志

见 [变动情况](https://github.com/capacitor-community/keep-awake/blob/master/CHANGELOG.md)。 。 。 .

## 许可证

见 [自由主义](https://github.com/capacitor-community/keep-awake/blob/master/LICENSE)。 。 。 .

## 常见问题

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

阻止你的屏幕睡觉\!

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

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

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

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

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

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

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

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

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

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

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

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