让开源，少一点语言距离。
npm包中文文档

@flatfile/listener

中文文档
1.1.2发布于 2025/04/25MITTypeScriptESM + CJS近 30 天下载 93.7万

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

中文使用文档
中文原文
文档目录8 节
  1. 构成部分
  2. FlatfileRecord and FlatfileRecords
  3. FlatfileSession
  4. EventCache
  5. EventHandler
  6. AuthenticatedClient
  7. 各种公用功能和类型:
  8. 开始

@ 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 开始, 请跟着我们 快速启动指南。 。 。 .

版本与发布记录

@flatfile/listener 共发布 53 个版本，首次发布于 2023/03/02；过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.2latest2025/04/251.6 年前
1.1.12024/12/031.9 年前
1.1.02024/09/282 年前
1.0.52024/05/212 年前
1.0.42024/05/022 年前
1.0.22024/04/112 年前

其他发布通道：next → 0.3.19-rc8。

关于 @flatfile/listener 的常见问题

@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 和提交记录判断。