Skip to content

@neosjs/electron-ipc ​

Electron IPC 封装库,目前提供基于 electron-updater 的渲染端自动更新 API(upgradesApi)与统一的 IPC 通道名常量(ipcEvents)。渲染进程无需直接接触 ipcRenderer 与 electron-updater,即可完成检查更新、下载更新、安装更新的完整流程,并以 Promise + 事件的方式获取进度与结果。

安装 ​

sh
pnpm add @neosjs/electron-ipc
sh
npm i @neosjs/electron-ipc
sh
yarn add @neosjs/electron-ipc

环境要求

Node.js >= 22.14.0。运行时依赖 electron-updater,请确保项目内已安装 Electron。

快速上手 ​

在渲染进程中导入 upgradesApi,即可调用更新相关能力:

ts
import { upgradesApi } from '@neosjs/electron-ipc'

// 检查更新,返回 electron-updater 的 UpdateInfo
const info = await upgradesApi.checkUpgrades()

// 下载更新并监听进度
await upgradesApi.downloadUpgrades((res) => {
  console.log(`下载进度:${res.percent * 100}%`)
})

// 下载完成后安装(退出并安装)
upgradesApi.installUpgrades()

downloadUpgrades 的第一个参数也可以是 autoInstall,传入 true 时下载完成会自动安装:

ts
// 下载完成后自动退出并安装
await upgradesApi.downloadUpgrades(true)

// macOS 安装更新(内部自动执行「检查 → 下载 → 安装」)
await upgradesApi.installMacUpdates()

API ​

upgradesApi ​

继承自 EventEmitter 的渲染端更新 API 单例,基于 ipcRenderer 与主进程通信:

方法说明
autoCheckUpgrades()触发主进程自动检查更新
checkUpgrades(callback?)检查更新,返回 Promise<UpdateInfo>(UpdateInfo 来自 electron-updater),可选回调拿到同一结果
downloadUpgrades(autoInstall?, callback?)下载更新;autoInstall 为 true 时下载完成后自动安装,callback 接收下载进度(含 percent 字段);也支持只传回调函数
installUpgrades()退出应用并安装更新
installMacUpdates()macOS 安装更新:先检查更新,有更新则以 autoInstall 方式下载安装

实例上还暴露 apiName、version、updateTime 属性。下载过程中会通过 this.emit('downloadUpgrades', res) 对外派发进度事件,可用 upgradesApi.on('downloadUpgrades', cb) 监听。

ipcEvents ​

包内统一维护的 IPC 通道名常量,主进程与渲染进程共用同一份定义,避免通道名硬编码:

ts
import { ipcEvents } from '@neosjs/electron-ipc'

ipcRenderer.send(ipcEvents.CHECK_UPDATES)
常量说明
CHECK_UPDATES检查更新
CHECK_FOR_UPDATES_RES检查更新结果
AUTO_CHECK_UPDATES自动检查更新
AUTO_UPDATES自动更新(检查并通知)
DOWNLOAD_UPDATE下载更新
DOWNLOAD_PROGRESS下载进度
UPDATES_DOWNLOADED_COMPLETE更新下载完成
QUIT_AND_INSTALL退出并安装

其他导出 ​

导出说明
VERSION当前版本号
RELEASE_TIME发布时间戳