# @flatfile/listener 中文文档

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

版本：1\.1\.2
npm 元数据更新时间：2026-04-23T23:54:28.010Z
中文译文更新时间：2026-11-14T21:47:00.219Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40flatfile/listener
原文对照：https://npmcn.com/package/%40flatfile/listener/?lang=original

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

- 包体积（解压后）：157 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：@flatfile/api ^1\.8\.5
- 首次发布：2023-03-02T00:33:55.838Z
- 最新版本发布：2025-04-24T17:46:35.554Z
- 近 30 天下载量：937137（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：53（近 12 个月 0 个）

## 中文简介

配置和使用平面文件的 PubSub 听器

## 安装

```sh
npm install @flatfile/listener
```

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

## README

# @ flatfile/ listener (帮助) name

`@flatfile/listener` 是 Flatfile 的核心库。 它将事件处理能力与Flatfile特定功能相结合,例如与Flatfile记录和会话合作. 简而言之,它接收事件,并对事件作出反应。 期间.

这个 `AuthenticatedClient` 类是认证的 API 通信的基础,而事件相关类则在 Flatfile 生态系统内允许事件驱动的工作流程.

## 构成部分

以下是该套件及其组成部分的概述:

### `FlatfileRecord and FlatfileRecords`

-   这些类代表了以"平分"格式记录和所收录的记录.
-   它们提供了操纵和检索记录数据的方法.

### `FlatfileSession`

-   此类代表了Flatfile平台中的会话.
-   它存储有关工作空间、工作手册、计划、上传和其他会话相关数据的信息.

### `EventCache`

-   此类执行事件缓存机制 .
-   它允许基于缓存密钥对事件数据进行缓存和检索.

### `EventHandler`

此类是事件处理器执行, 扩展了认证的 Client 类 .

-   它提供了登记活动听众、发送活动和管理儿童活动处理者的方法.
-   它支持基于主题和上下文的过滤事件.
-   它可用于处理和处理Flatfile平台上的事件.

### `AuthenticatedClient`

此类是认证的 HTTP 客户端的基础类 .

-   它提供了使用Axios进行认证的HTTP请求的功能.
-   它处理访问符,API URL以及HTTP头.

### 各种公用功能和类型:

`@flatfile/listener` 包括与事件处理、过滤和数据操作有关的实用功能和类型.

这些公用事业支持事件处理和数据处理组件的功能.

## 开始

要从 @ flatfile/ listener 开始, 请跟着我们 [快速启动指南](https://flatfile.com/docs/quickstart/meet-the-workbook)。 。 。 .

## 常见问题

### @flatfile/listener 是什么？

配置和使用平面文件的 PubSub 听器

### 如何安装 @flatfile/listener？

在项目目录运行 npm install @flatfile/listener，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@flatfile/api（^1\.8\.5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flatfile/listener 支持 TypeScript 吗？

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

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

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

### @flatfile/listener 可以商用吗？

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

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

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

### @flatfile/listener 还在维护吗？

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