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

@flatfile/util-extractor

中文文档
2.8.0发布于 2025/10/18ISCTypeScriptESM + CJS近 30 天下载 7.2万

包含公共公用事业和提取器辅助工具的图书馆.

中文使用文档
中文原文
文档目录6 节
  1. 代码分解
  2. 导入语句
  3. 提取函数
  4. 采掘业
  5. 帮助函数
  6. 类型定义

这个 @flatfile/util-extractor 工具旨在处理各种文件格式并高效地提取结构化数据。 它能利用Flatfile API的力量来方便平滑地提取和处理数据.

嵌入Flatfile时,该插件应被部署在服务器侧听器中. 学多点

代码分解

此代码定义了在Flatfile提取器插件中用于数据提取的共享工具. 这个工具的用法是使用Flatfile API处理文件并从中提取结构化数据. 它利用各种平面文件SDK组件和公用事业(@ flatfile/ util- 文件缓冲器 以高效地进行数据提取过程。 让我们来细分代码的主要组件:

导入语句

  • 代码从导入数据提取所需的各种依赖性和模块开始. 其中包括: FlatfileListener 从 @flatfile/listener, (中文(简体) ), fileBuffer 从 @flatfile/util-file-buffer, (中文(简体) ), api 财务报告和审定财务报表 Flatfile 从 @flatfile/api,以及 mapValues 从 remeda。 。 。 .

提取函数

  • 这个 Extractor 函数是工具的主要切入点。 它需要三个参数:
    • fileExt: 代表待处理文件扩展名的字符串或正则表达式.
    • parseBuffer: 处理文件缓冲并返回的回调函数a WorkbookCapture。 。 。 .
    • options: 包含数据提取附加配置选项的可选对象.
      • options.chunkSize:指定每个块的记录数量。 默认值是 10_000。 。 。 .
      • options.parallel: 确定同时处理的块数。 默认值是 1。 。 。 .
  • 内部 Extractor 函数,用于截取带有指定扩展名的文件并进行提取过程.

采掘业

  • 收到带有指定扩展名的文件后,便开始提取过程. 该工具创建了使用 Flatfile API 来跟踪提取进度的工作 .
  • 这个 parseBuffer 然后调用函数以使用提供的选项从文件缓冲器中提取数据.
  • 根据使用 createWorkbook 函数。 然后用包含所取出的数据的活页来更新工作手册.

帮助函数

  • 代码包含一些帮助提取过程的功能:
    • createWorkbook: 根据所提取的数据创建一个平面文件工作手册.
    • getWorkbookConfig:生成工作手册的配置,包括工作表名称、字段和限制.
    • getSheetConfig:生成每个工作表的配置,包括字段名称、标签和限制.
    • asyncBatch: 用于同步处理数据以改善性能的功能.

类型定义

  • 代码定义了两种通用类型结构: WorkbookCapture 财务报告和审定财务报表 SheetCapture。这些类型代表了所捕获的工作手册和工作单的结构.

版本与发布记录

@flatfile/util-extractor 共发布 58 个版本，首次发布于 2023/08/02；过去 12 个月发布了 0 个版本。

版本发布日期距今
2.8.0latest2025/10/181.1 年前
2.7.52025/09/201.2 年前
2.7.42025/08/281.2 年前
2.7.32025/08/271.2 年前
2.7.22025/08/151.3 年前
2.7.12025/07/131.3 年前

关于 @flatfile/util-extractor 的常见问题

@flatfile/util-extractor 是什么？

包含公共公用事业和提取器辅助工具的图书馆.

如何安装 @flatfile/util-extractor？

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

@flatfile/util-extractor 支持 TypeScript 吗？

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

@flatfile/util-extractor 支持 ESM 还是 CommonJS？

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

@flatfile/util-extractor 需要什么版本的 Node.js？

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

@flatfile/util-extractor 可以商用吗？

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

@flatfile/util-extractor 的下载量有多少？

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

@flatfile/util-extractor 还在维护吗？

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