# @cuj1559/electron-push-receiver 中文文档

规范地址：https://npmcn.com/package/%40cuj1559/electron-push-receiver/

版本：3\.1\.8
npm 元数据更新时间：2024-10-01T08:47:11.001Z
中文译文更新时间：2026-11-11T04:35:09.442Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cuj1559/electron-push-receiver
原文对照：https://npmcn.com/package/%40cuj1559/electron-push-receiver/?lang=original
项目主页：https://github.com/Choiman1559/electron-push-receiver#readme
源码仓库：https://github.com/Choiman1559/electron-push-receiver

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

- 包体积（解压后）：13.7 kB，15 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2024-01-24T10:40:44.071Z
- 最新版本发布：2024-10-01T08:47:10.829Z
- 近 30 天下载量：4930（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 0 个）

## 中文简介

使用 HTTP v1 API 在电子中接收 FCM 通知的模块

## 安装

```sh
npm install @cuj1559/electron-push-receiver
```

也可以使用：`pnpm add @cuj1559/electron-push-receiver`、`yarn add @cuj1559/electron-push-receiver`、`bun add @cuj1559/electron-push-receiver`

## README

# 电子推收器

一个将 Web Push 支持带入的模块 [电子](https://github.com/electron/electron) 允许它从Firebase Cloud Massaging(FCM)接收通知.

此特定的分叉用途 [阿拉克纳FCM](https://github.com/queelag/fcm) 用于支持 FCM 新的 HTTP v1 API

## 安装

```
npm i -S @cuj1559/electron-push-receiver
```

点击 [这里](https://www.npmjs.com/package/@cuj1559/electron-push-receiver) 查看 npm 页面.

## 使用量

-   单位 `main.js` / 在主要过程中:

```javascript
const { setup: setupPushReceiver } = require('@cuj1559/electron-push-receiver');

// Call it before 'did-finish-load' with mainWindow a reference to your window
setupPushReceiver(mainWindow.webContents);
```

-   在渲染工艺中:

```javascript
import { ipcRenderer } from 'electron';
import {
  START_NOTIFICATION_SERVICE,
  NOTIFICATION_SERVICE_STARTED,
  NOTIFICATION_SERVICE_RESTARTED,
  NOTIFICATION_SERVICE_ERROR,
  NOTIFICATION_RECEIVED as ON_NOTIFICATION_RECEIVED,
  TOKEN_UPDATED,
} from '@cuj1559/electron-push-receiver/src/constants';

// Listen for service successfully started
ipcRenderer.on(NOTIFICATION_SERVICE_STARTED, (_, token) => { /* do something */ });
// Listen for service restart due to server connection failure
ipcRenderer.on(NOTIFICATION_SERVICE_RESTARTED, (_, token) => { /* do something */ });
// Handle notification errors
ipcRenderer.on(NOTIFICATION_SERVICE_ERROR, (_, error) => { /* handle error */ });
// Send FCM token to backend
ipcRenderer.on(TOKEN_UPDATED, (_, token) => { /* check or save token */ });
// Display notification
ipcRenderer.on(ON_NOTIFICATION_RECEIVED, (_, notification) =>  { /* notification data received */ });
// Start service
ipcRenderer.send(START_NOTIFICATION_SERVICE, appID, projectID, apiKey, vapidKey);
```

## 常见问题

### @cuj1559/electron-push-receiver 是什么？

使用 HTTP v1 API 在电子中接收 FCM 通知的模块

### 如何安装 @cuj1559/electron-push-receiver？

在项目目录运行 npm install @cuj1559/electron-push-receiver，或使用 pnpm add / yarn add / bun add。

### @cuj1559/electron-push-receiver 支持 TypeScript 吗？

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

### @cuj1559/electron-push-receiver 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cuj1559/electron-push-receiver 可以商用吗？

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

### @cuj1559/electron-push-receiver 的下载量有多少？

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

### @cuj1559/electron-push-receiver 还在维护吗？

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