# @flatfile/util-file-buffer 中文文档

规范地址：https://npmcn.com/package/%40flatfile/util-file-buffer/

版本：0\.6\.0
npm 元数据更新时间：2026-04-23T23:54:59.231Z
中文译文更新时间：2026-11-14T21:50:14.165Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：17.4 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：0 个
- peer 依赖：@flatfile/api ^1\.9\.19，@flatfile/listener ^1\.1\.0
- 首次发布：2023-07-31T23:01:17.433Z
- 最新版本发布：2024-11-07T20:50:11.571Z
- 近 30 天下载量：72318（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 0 个）

## 中文简介

从任何文件中取出数据并作为缓冲器提供的工具

## 安装

```sh
npm install @flatfile/util-file-buffer
```

也可以使用：`pnpm add @flatfile/util-file-buffer`、`yarn add @flatfile/util-file-buffer`、`bun add @flatfile/util-file-buffer`

## README

这个 `@flatfile/util-file-buffer` 工具提供了一种方便的方式来处理文件,并利用Flatfile API来取出文件的内容. 它允许您匹配基于文件扩展或正则表达式的特定文件,并检索其内容作为进一步处理的缓冲.

> 嵌入Flatfile时,该插件应被部署在服务器侧听器中. [学多点](https://npmcn.com/docs/orchestration/listeners#listener-types)

## 代码分解

此代码定义 `fileBuffer` 用于处理文件处理的 Flatfile 提取器插件中的工具。 该工具允许您截取文件创建事件并检索文件内容作为后续操作的缓冲. 让我们来细分代码的主要组件:

### **导入语句**

-   代码首先导入文件缓冲所需的必要的依赖和模块. 其中包括: `FlatfileEvent` 财务报告和审定财务报表 `FlatfileListener` 从 `@flatfile/listener`,以及 `api` 财务报告和审定财务报表 `Flatfile` 从 `@flatfile/api`。 。 。 .

### **文件缓冲函数**

-   这个 `fileBuffer` 函数是工具的核心,是拦截文件创建事件的中间软件功能.
-   它需要两个参数:
    -   `matchFile`: 代表文件扩展名的字符串或正则表达式来匹配处理.
    -   `callback`:接收文件元数据、文件缓冲和Flatfile事件的回调函数.

### **事件听众**

-   内部 `fileBuffer` 函数,提供 `listener` 被配置为监听 `file:created` 事件。 当创建文件时,此事件将被触发 .

### **匹配文件**

-   当a `file:created` 事件发生时,工具会使用 Flatfile API 获取相应的文件元数据,如果文件名称与指定的文件名称相匹配则检查 `matchFile`。 。 。 .
-   若为 `matchFile` 是一个字符串,如果文件名以指定的扩展名结尾,则进行工具检查.
-   若为 `matchFile` 是正则表达式,如果文件名称与正则表达式相匹配,则使用检查.

### **缓冲文件内容**

-   如果文件与指定的匹配 `matchFile`,工具将使用 `getFileBuffer` 函数.
-   这个 `getFileBuffer` 函数使用 Flatfile API 下载文件并将其内容读入缓冲器.

### **回调执行**

-   获取文件缓冲器后, 工具会引用所提供的 `callback` 以文件元数据、缓冲和 Flatfile 事件作为参数.

### **帮助函数**

-   代码包含一个名为帮助器的函数 `getFileBuffer` 负责下载文件并缓冲其内容.

## 示例使用

```javascript
import { fileBuffer } from "@flatfile/util-file-buffer";
import api, { Flatfile } from "@flatfile/api";

// Define the callback function to process the file buffer
const processFileBuffer = (
  file: Flatfile.File_,
  buffer: Buffer,
  event: FlatfileEvent
) => {
  // Your file processing logic here...
};

// Register the fileBuffer middleware to intercept file:created events
const fileBufferMiddleware = fileBuffer(".csv", processFileBuffer);
listener.use(fileBufferMiddleware);
```

在这个例子中,文件缓冲器中间软件用于截取.csv文件并将其内容作为缓冲器传递到进程File缓冲器函数,以便进一步处理.

## 常见问题

### @flatfile/util-file-buffer 是什么？

从任何文件中取出数据并作为缓冲器提供的工具

### 如何安装 @flatfile/util-file-buffer？

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

### @flatfile/util-file-buffer 支持 TypeScript 吗？

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

### @flatfile/util-file-buffer 支持 ESM 还是 CommonJS？

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

### @flatfile/util-file-buffer 需要什么版本的 Node\.js？

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

### @flatfile/util-file-buffer 可以商用吗？

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

### @flatfile/util-file-buffer 的下载量有多少？

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

### @flatfile/util-file-buffer 还在维护吗？

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