# @gesher/sdk 中文文档

规范地址：https://npmcn.com/package/%40gesher/sdk/

版本：0\.1\.1
npm 元数据更新时间：2026-04-07T11:09:07.116Z
中文译文更新时间：2026-11-16T05:33:00.921Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：44.1 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-04-07T09:22:37.459Z
- 最新版本发布：2026-04-07T11:09:06.683Z
- 近 30 天下载量：4808（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

Gesher 驱动通知服务的浏览器 SDK

## 安装

```sh
npm install @gesher/sdk
```

也可以使用：`pnpm add @gesher/sdk`、`yarn add @gesher/sdk`、`bun add @gesher/sdk`

## README

# @ gesher/ sdk (英语)

[盖舍](https://gesher.pro/) 是 Otomator 的主机网络推取服务: 您的后端发送通知; 这个 SDK 帮助浏览器订阅和接收它们, 而不会在客户端中曝光 API 密钥 .

## 安装

```bash
npm install @gesher/sdk
```

## 快开始

1.  复制 `node_modules/@gesher/sdk/gesher-sw.js` (或导入路径) `@gesher/sdk/sw` 用于文件的捆绑解析)到您的站点 **公开** 根,例如:. `public/gesher-sw.js`因此,它被服务于 `/gesher-sw.js`。 。 。 .
    
2.  指着SDK **** 后端 URL; 您的服务器代理 `api.gesher.pro` 用熊鼠 API 键.
    

```typescript
import { GesherClient } from '@gesher/sdk'

const gesher = new GesherClient({
  subscribeEndpoint: '/api/push/subscribe',
  unsubscribeEndpoint: '/api/push/unsubscribe',
  // Optional: omit to fetch from https://api.gesher.pro/vapid-key
  // vapidPublicKey: '...',
})

const result = await gesher.subscribe('user-123')
if (!result.ok) console.error(result.error)

if (await gesher.isSubscribed()) {
  // ...
}

await gesher.unsubscribe() // or unsubscribe('user-123')
```

## PWA 安装( 可选)

如果您的应用程序是带有网络应用程序表的进取 Web App, 您可以使用 SDK 助手来抓取 `beforeinstallprompt` 并显示安装按钮.

```typescript
const gesher = new GesherClient({
  subscribeEndpoint: '/api/push/subscribe',
  unsubscribeEndpoint: '/api/push/unsubscribe',
})

// Call once at app startup
gesher.watchInstall()

// Show an "Install App" button when ready
gesher.onInstallStateChange((state) => {
  if (state === 'available') showInstallButton()
  if (state === 'installed') hideInstallButton()
})

// On button click
document.getElementById('install-btn')!.onclick = async () => {
  const result = await gesher.install()
  if (result.accepted) console.log('App installed!')
}
```

## 后端代理( Express)

你的路线从SDK接收了JSON尸体,并用密钥转发给格舍尔:

```javascript
app.post('/api/push/subscribe', async (req, res) => {
  const r = await fetch('https://api.gesher.pro/subscribe', {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.GESHER_API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(req.body),
  })
  res.status(r.status).send(await r.text())
})
```

未订阅使用相同的 JSON 机构(`userId`, (中文(简体) ), `endpoint`与 `DELETE`数字 :

```javascript
app.post('/api/push/unsubscribe', async (req, res) => {
  const r = await fetch('https://api.gesher.pro/unsubscribe', {
    method: 'DELETE',
    headers: {
      Authorization: `Bearer ${process.env.GESHER_API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(req.body),
  })
  res.status(r.status).send(await r.text())
})
```

## 配置

| 选项 | 说明 |
| --- | --- |
| `subscribeEndpoint` | 您的后端 URL; SDK POST `{ userId, subscription }`。 。 。 . |
| `unsubscribeEndpoint` | 您的后端 URL; SDK POST `{ userId, endpoint }`。 。 。 . |
| `vapidPublicKey` | 可选的 URL 安全基础64 公钥; 如果省略, 从中获取 `vapidKeyEndpoint`。 。 。 . |
| `vapidKeyEndpoint` | 可选的 默认为 `https://api.gesher.pro/vapid-key`。 。 。 . |
| `serviceWorkerPath` | 可选的 默认 `/gesher-sw.js`。 。 。 . |
| `serviceWorkerScope` | 可选的 默认 `/`。 。 。 . |

## 类型脚本

配置类型和有效载荷出口自 `@gesher/sdk`。 。 。 .

## 文档

更详细的情况: [页:1](https://gesher.pro/docs)

## 常见问题

### @gesher/sdk 是什么？

Gesher 驱动通知服务的浏览器 SDK

### 如何安装 @gesher/sdk？

在项目目录运行 npm install @gesher/sdk，或使用 pnpm add / yarn add / bun add。

### @gesher/sdk 支持 TypeScript 吗？

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

### @gesher/sdk 支持 ESM 还是 CommonJS？

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

### @gesher/sdk 可以商用吗？

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

### @gesher/sdk 的下载量有多少？

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

### @gesher/sdk 还在维护吗？

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

