# @capacitor/live-updates 中文文档

规范地址：https://npmcn.com/package/%40capacitor/live-updates/

版本：0\.5\.0
npm 元数据更新时间：2026-09-28T18:17:23.937Z
中文译文更新时间：2026-11-09T02:19:04.712Z
软件包许可：Commercial

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

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

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

- 包体积（解压后）：63.2 kB，22 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@capacitor/core \>=8\.0\.0
- 首次发布：2022-10-03T17:17:21.768Z
- 最新版本发布：2026-02-02T17:31:40.548Z
- 近 30 天下载量：152328（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 1 个）

## 中文简介

Capacitor 的官方 Live 更新插件

## 安装

```sh
npm install @capacitor/live-updates
```

也可以使用：`pnpm add @capacitor/live-updates`、`yarn add @capacitor/live-updates`、`bun add @capacitor/live-updates`

## README

# @ mictor/ live- updates (英语)

Capacitor 的官方 Live 更新插件

## 安装

```bash
npm install @capacitor/live-updates
npx cap sync
```

## API 密码

-   [`sync()`](https://npmcn.com/package/%40capacitor/live-updates/#readme-sync)
-   [`setConfig(...)`](https://npmcn.com/package/%40capacitor/live-updates/#readme-setconfig)
-   [`getConfig()`](https://npmcn.com/package/%40capacitor/live-updates/#readme-getconfig)
-   [`resetConfig()`](https://npmcn.com/package/%40capacitor/live-updates/#readme-resetconfig)
-   [`reload()`](https://npmcn.com/package/%40capacitor/live-updates/#readme-reload)
-   [接口](https://npmcn.com/package/%40capacitor/live-updates/#readme-interfaces)
-   [类型异名](https://npmcn.com/package/%40capacitor/live-updates/#readme-type-aliases)

### 同步(...)

```typescript
sync(progress: ((percentage: number) => void) | undefined = undefined) => Promise<SyncResult>
```

与 Live 更新同步应用程序 。 可选的回调.

**回返情况:** `Promise<[SyncResult](https://npmcn.com/package/%40capacitor/live-updates/#readme-syncresult)>`

* * *

### 设置 Config (...)

```typescript
setConfig(config: LiveUpdateConfig) => Promise<void>
```

| 参数 | 类型 |
| --- | --- |
| **`config`** | `[LiveUpdateConfig](https://npmcn.com/package/%40capacitor/live-updates/#readme-liveupdateconfig)` |

* * *

### 获取Config ()

```typescript
getConfig() => Promise<LiveUpdateConfig>
```

**回返情况:** `Promise<[LiveUpdateConfig](https://npmcn.com/package/%40capacitor/live-updates/#readme-liveupdateconfig)>`

* * *

### 重新设置Config ()

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

* * *

### 重新装入( c)

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

* * *

### 接口

#### 同步结果

| Prop | 类型 |
| --- | --- |
| **`liveUpdate`** | `[LiveUpdate](https://npmcn.com/package/%40capacitor/live-updates/#readme-liveupdate)` |
| **`snapshot`** | `[Snapshot](https://npmcn.com/package/%40capacitor/live-updates/#readme-snapshot) | null` |
| **`source`** | `'download' | 'cache'` |
| **`activeApplicationPathChanged`** | `boolean` |

#### 实时更新

| Prop | 类型 |
| --- | --- |
| **`appId`** | `string` |
| **`channel`** | `string` |

#### 抓图

| Prop | 类型 |
| --- | --- |
| **`id`** | `string` |
| **`buildId`** | `string` |

#### Live Update 错误

| Prop | 类型 |
| --- | --- |
| **`appId`** | `string` |
| **`failStep`** | `'CHECK' | 'DOWNLOAD' | 'COPY' | 'UNPACK' | 'VERIFY' | 'UPDATE' | 'CANCEL'` |
| **`message`** | `string` |

#### Live Update 配置

| Prop | 类型 |
| --- | --- |
| **`appId`** | `string` |
| **`channel`** | `string` |
| **`autoUpdateMethod`** | `[AutoUpdateMethod](https://npmcn.com/package/%40capacitor/live-updates/#readme-autoupdatemethod)` |
| **`maxVersions`** | `number` |
| **`key`** | `string` |

### 类型异名

#### 现场更新

`[SyncResult](https://npmcn.com/package/%40capacitor/live-updates/#readme-syncresult) | [LiveUpdateError](https://npmcn.com/package/%40capacitor/live-updates/#readme-liveupdateerror)`

#### 自动更新方法

`'none' | 'background'`

#### Live Update 配置

`[Partial](https://npmcn.com/package/%40capacitor/live-updates/#readme-partial)<[LiveUpdate](https://npmcn.com/package/%40capacitor/live-updates/#readme-liveupdate)> & { autoUpdateMethod?: 'none' | 'background'; strategy?: 'zip' | 'differential'; enabled?: boolean; maxVersions?: number; }`

#### 部分

让 T 中的所有属性可选

`{ [P in keyof T]?: T[P]; }`

## 常见问题

### @capacitor/live-updates 是什么？

Capacitor 的官方 Live 更新插件

### 如何安装 @capacitor/live-updates？

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

### @capacitor/live-updates 支持 TypeScript 吗？

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

### @capacitor/live-updates 支持 ESM 还是 CommonJS？

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

### @capacitor/live-updates 可以商用吗？

@capacitor/live-updates 使用 Commercial 许可。声明的许可为 Commercial，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @capacitor/live-updates 的下载量有多少？

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

### @capacitor/live-updates 还在维护吗？

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