@capacitor/live-updates

中文文档
0.5.0发布于 2026/02/03CommercialTypeScriptESM + CJS零依赖近 30 天下载 15.2万

Capacitor 的官方 Live 更新插件

中文使用文档
文档目录9 节
  1. 安装
  2. API 密码
  3. 同步(...)
  4. 设置 Config (...)
  5. 获取Config ()
  6. 重新设置Config ()
  7. 重新装入( c)
  8. 接口
  9. 类型异名

@ mictor/ live- updates (英语)

Capacitor 的官方 Live 更新插件

安装

npm install @capacitor/live-updates
npx cap sync

API 密码

同步(...)

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

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

回返情况: Promise<SyncResult>


设置 Config (...)

setConfig(config: LiveUpdateConfig) => Promise<void>
参数类型
configLiveUpdateConfig

获取Config ()

getConfig() => Promise<LiveUpdateConfig>

回返情况: Promise<LiveUpdateConfig>


重新设置Config ()

resetConfig() => Promise<void>

重新装入( c)

reload() => Promise<void>

接口

同步结果

Prop类型
liveUpdateLiveUpdate
snapshotSnapshot | null
source'download' | 'cache'
activeApplicationPathChangedboolean

实时更新

Prop类型
appIdstring
channelstring

抓图

Prop类型
idstring
buildIdstring

Live Update 错误

Prop类型
appIdstring
failStep'CHECK' | 'DOWNLOAD' | 'COPY' | 'UNPACK' | 'VERIFY' | 'UPDATE' | 'CANCEL'
messagestring

Live Update 配置

Prop类型
appIdstring
channelstring
autoUpdateMethodAutoUpdateMethod
maxVersionsnumber
keystring

类型异名

现场更新

SyncResult | LiveUpdateError

自动更新方法

'none' | 'background'

Live Update 配置

Partial<LiveUpdate> & { autoUpdateMethod?: 'none' | 'background'; strategy?: 'zip' | 'differential'; enabled?: boolean; maxVersions?: number; }

部分

让 T 中的所有属性可选

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

版本与发布记录

@capacitor/live-updates 共发布 20 个版本,首次发布于 2022/10/04;过去 12 个月发布了 1 个版本。

版本发布日期距今
0.5.0latest2026/02/039 个月前
0.4.02025/01/221.8 年前
0.3.12024/08/062 年前
0.3.02024/08/052 年前
0.2.12024/04/302 年前
0.2.02024/04/262 年前

其他发布通道:dev → 0.1.1-beta.6。

关于 @capacitor/live-updates 的常见问题

@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 和提交记录判断。