# @flatfile/listener-driver-pubsub 中文文档

规范地址：https://npmcn.com/package/%40flatfile/listener-driver-pubsub/

版本：3\.0\.0
npm 元数据更新时间：2026-11-11T21:46:48.521Z
中文译文更新时间：2026-11-14T21:47:42.342Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40flatfile/listener-driver-pubsub
原文对照：https://npmcn.com/package/%40flatfile/listener-driver-pubsub/?lang=original
项目主页：https://github.com/FlatFilers/flatfile-core-libraries#readme
源码仓库：https://github.com/FlatFilers/flatfile-core-libraries

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

- 包体积（解压后）：13.1 kB，5 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：5 个
- 首次发布：2023-06-07T02:57:44.764Z
- 最新版本发布：2026-11-11T21:46:48.094Z
- 近 30 天下载量：113383（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 1 个）

## 中文简介

通过 pubsub 模式从 Flatfile 流出事件的驱动程序

## 安装

```sh
npm install @flatfile/listener-driver-pubsub
```

也可以使用：`pnpm add @flatfile/listener-driver-pubsub`、`yarn add @flatfile/listener-driver-pubsub`、`bun add @flatfile/listener-driver-pubsub`

## README

# `@flatfile/listener-driver-pubsub`

本文件就如何使用 `PubSubDriver` 类,用于 `@flatfile/listener` 软件包.

## 导言

`PubSubDriver` 是一个 `EventDriver` 使用实时消息系统来收听事件。 它使用Flatfile API进行认证,必要时自动处理再认证.

司机需要一个 `scope`,它可以是环境,也可以是空间标识。 它还为Axios设置了截取器,有助于调试HTTP请求.

## 使用量

导入必要的依赖性 :

```javascript
import { EventDriver } from '@flatfile/listener'
import { PubSubDriver } from './PubSubDriver'
```

创建新 `PubSubDriver` 实例,通过 `scope` 作为字符串( 环境标识或空间标识) :

```javascript
const pubSubDriver = new PubSubDriver('your-environment-or-space-id')
```

启动驱动程序 :

```javascript
pubSubDriver.mount(instanceOfListenerClient)
pubSubDriver.start()
```

请注意: `start` 方法是一个同步并返回一个承诺.

这个 `PubSubDriver` 实例将自动订阅相应的事件频道 `scope`,然后在事件进入时开始处理.

它还处理连接状态事件,记录成功连接和出错,并在必要时自动再校正.

## 日志

这个 `PubSubDriver` 使用该 `Debugger` 从 `@flatfile/utils-debugger` 以记录事件。 日志条目包括成功的连接,出错,以及事件处理信息.

例如,当驱动程序成功连接到事件流时,它会用范围记录一个成功的信息:

```shell
  ✅ Connected to event stream for scope your-environment-or-space-id
```

请参看 `@flatfile/utils-debugger` 组合文档,以获取更多关于伐木工作的信息.

## Axios 拦截器

这个 `axiosInterceptor` 从 `@flatfile/utils-debugger` 当 `PubSubDriver` ,这可以帮助调试使用 Axios 的 HTTP 请求.

请参看 `@flatfile/utils-debugger` 软件包文档,以获取关于Axios拦截器如何工作的更多信息.

## 错误

如果 `scope` 初始化期间未提供 `PubSubDriver`,则出现错误:

```shell
Error: scope is required (must be an environment or space id)
```

请确保 `scope` 在创建新时提供 `PubSubDriver` 举个例子.

## 常见问题

### @flatfile/listener-driver-pubsub 是什么？

通过 pubsub 模式从 Flatfile 流出事件的驱动程序

### 如何安装 @flatfile/listener-driver-pubsub？

在项目目录运行 npm install @flatfile/listener-driver-pubsub，或使用 pnpm add / yarn add / bun add。

### @flatfile/listener-driver-pubsub 支持 TypeScript 吗？

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

### @flatfile/listener-driver-pubsub 支持 ESM 还是 CommonJS？

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

### @flatfile/listener-driver-pubsub 需要什么版本的 Node\.js？

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

### @flatfile/listener-driver-pubsub 可以商用吗？

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

### @flatfile/listener-driver-pubsub 的下载量有多少？

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

### @flatfile/listener-driver-pubsub 还在维护吗？

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