# @subscriber\.dev/sdk 中文文档

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

版本：0\.1\.1
npm 元数据更新时间：2026-11-02T13:58:31.795Z
中文译文更新时间：2026-11-02T14:21:39.891Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40subscriber.dev/sdk
原文对照：https://npmcn.com/package/%40subscriber.dev/sdk/?lang=original
项目主页：https://docs.subscriber.dev/
源码仓库：https://github.com/kanbn/subscriber.dev

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

- 包体积（解压后）：226 kB，37 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-10-20T14:31:53.461Z
- 最新版本发布：2026-11-02T13:58:31.491Z
- 已发布版本数：3（近 12 个月 3 个）

## 中文简介

subscriber.dev API的TypeScript SDK

## 安装

```sh
npm install @subscriber.dev/sdk
```

也可以使用：`pnpm add @subscriber.dev/sdk`、`yarn add @subscriber.dev/sdk`、`bun add @subscriber.dev/sdk`

## README

# @subscriber.dev / sdk

的TypeScript SDK [subscriber.dev](https://subscriber.dev/)：添加订阅者并从你的应用程序中触发工作流。

```bash
npm install @subscriber.dev/sdk
```

## 获取API密钥

```bash
subscriber keys create "Acme app"
```

键属于一个环境，因此请求不会命名它。它只显示一次：将其存储为 `SUBSCRIBER_API_KEY` 把它保存在你的服务器上。

关键是 `limited` 默认情况下：它可以创建和更新订阅者并触发工作流。通过 `--access full` 为了其他的一切。看到 [身份验证](https://docs.subscriber.dev/api-reference/introduction#authentication).

## 使用它

```ts
import { Subscriber } from "@subscriber.dev/sdk";

const client = new Subscriber(process.env.SUBSCRIBER_API_KEY);

await client.workflows.trigger({
  key: "welcome",
  subscriber: { email: "jane@acme.com", firstName: "Jane" },
  payload: { plan: "pro" },
});
```

`new Subscriber()` 没有参数的情况下读取 `SUBSCRIBER_API_KEY`． 每次调用返回 `{ data, response }`.

## 错误

失败的请求会抛出 `SubscriberError` 与API的消息和状态：

```ts
import { SubscriberError } from "@subscriber.dev/sdk";

try {
  await client.workflows.trigger({ key: "welcome", subscriber: { email } });
} catch (error) {
  if (error instanceof SubscriberError && error.status === 404) {
    console.warn(error.message);
  }
}
```

`error.errors` 列表上的无效字段 `400`.

## 选项

```ts
new Subscriber(apiKey, {
  baseUrl: "https://api.yourdomain.com",
  fetch: customFetch,
});
```

使用 `baseUrl` 如果你 [self-host](https://docs.subscriber.dev/self-hosting).

## 许可证

麻省理工学院

## 常见问题

### @subscriber\.dev/sdk 是什么？

subscriber\.dev API的TypeScript SDK

### 如何安装 @subscriber\.dev/sdk？

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

### @subscriber\.dev/sdk 支持 TypeScript 吗？

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

### @subscriber\.dev/sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @subscriber\.dev/sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @subscriber\.dev/sdk 可以商用吗？

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

### @subscriber\.dev/sdk 还在维护吗？

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