# @flatfile/plugin-delimiter-extractor 中文文档

规范地址：https://npmcn.com/package/%40flatfile/plugin-delimiter-extractor/

版本：2\.5\.2
npm 元数据更新时间：2026-04-23T23:54:41.298Z
中文译文更新时间：2026-11-14T22:35:53.997Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：70.8 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：3 个
- peer 依赖：@flatfile/api ^1\.9\.19
- 首次发布：2023-08-02T00:41:59.421Z
- 最新版本发布：2025-08-18T15:49:51.147Z
- 近 30 天下载量：2798（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 0 个）

## 中文简介

在 Flatfile 中解析.delicter 文件的插件 .

## 安装

```sh
npm install @flatfile/plugin-delimiter-extractor
```

也可以使用：`pnpm add @flatfile/plugin-delimiter-extractor`、`yarn add @flatfile/plugin-delimiter-extractor`、`bun add @flatfile/plugin-delimiter-extractor`

## README

这个 `@flatfile/plugin-delimiter-extractor` 软件包是一个插件,用于解析已划定的文件并将其取入Flatfile。 它利用各种图书馆对文件进行解析并有效检索结构化数据.

**事件类型 :** `listener.on('file:created')`

**支持的分隔符 :** `;`, (中文(简体) ), `:`, (中文(简体) ), `~`, (中文(简体) ), `^`, (中文(简体) ), `#`

**说明:** `\t`, (中文(简体) ), `|`,以及 `,` 在平台上由本地处理.

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

## 参数

#### `fileExt` - 说吧 `string` - (必须)

这个 `fileExt` 参数用于指定文件名称或扩展至 听着.

#### `options.delimiter` - 说吧 `string` - (必须)

这个 `delimiter` 参数用于指定文件中使用的分隔符.

#### `options.dynamicTyping` - 说吧 `boolean` - 说吧 `default: "false"`

若为 `true`,数字和布尔数据将转换成其类型,而不是 剩余字符串。 数字数据必须符合小数的定义 字义. 数值大于或小于 -2^53 的数值不会是 转换为数字以保持精度。 欧洲格式的数字必须 已经交换了逗号和点.

#### `options.skipEmptyLines` - 说吧 `boolean | 'greedy'`

若为 `true`,完全空行(那些对齐的行) 将跳过字符串 。 如果设置为 `greedy`,没有内容的行 (在解析后只有空白空间的)也将被跳过.

#### `options.transform` - 说吧 `function`

在每个值上应用的函数。 该函数作为 参数 该函数的回取值将取代它收到的值. 转换功能在之前应用 `dynamicTyping`。 。 。 .

#### `options.chunkSize` - 说吧 `default: 10_000` - 说吧 `number` - (可选)

这个 `chunkSize` 参数允许您指定要输入的记录数量 每个块.

#### `options.parallel` - 说吧 `default: 1` - 说吧 `number` - (可选)

这个 `parallel` 参数允许您指定要处理的块数 平行进行.

## API 调用

-   `api.files.download`
-   `api.files.get`
-   `api.files.update`
-   `api.jobs.ack`
-   `api.jobs.complete`
-   `api.jobs.create`
-   `api.jobs.fail`
-   `api.jobs.update`
-   `api.records.insert`
-   `api.workbooks.create`

## 使用量

听好了要上传到 Flatfile 的已划定文件 。 然后平台会自动取出文件. 一旦完成,文件将准备在文件区域导入 .

```bash
npm i @flatfile/plugin-delimiter-extractor
```

```js
import { DelimiterExtractor } from "@flatfile/plugin-delimiter-extractor";
```

```js
listener.use(DelimiterExtractor(".txt", { delimiter: ":" }));
```

### 完整示例

在这个例子中,DelicterExtractor被初始化,用于以可选选项提取TXT文件,然后被Flatfile收听器注册为中间软件. 当一个TXT文件被上传后,插件将提取结构化的数据并使用提取器的解析器处理.

```javascript
import { DelimiterExtractor } from "@flatfile/plugin-delimiter-extractor";

// Define optional options for the extractor (e.g., { dynamicTyping: true })
const options = {
  delimiter: ":",
  dynamicTyping: true,
  skipEmptyLines: true,
  transform: (value) => value.toUpperCase(),
};

// Initialize the TXT extractor
const delimiterExtractor = DelimiterExtractor(".txt", options);

// Register the extractor as a middleware for the Flatfile listener
listener.use(delimiterExtractor);

// When a TXT file is uploaded, the data will be extracted and processed using the extractor's parser.
```

## 常见问题

### @flatfile/plugin-delimiter-extractor 是什么？

在 Flatfile 中解析\.delicter 文件的插件 \.

### 如何安装 @flatfile/plugin-delimiter-extractor？

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

### @flatfile/plugin-delimiter-extractor 支持 TypeScript 吗？

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

### @flatfile/plugin-delimiter-extractor 支持 ESM 还是 CommonJS？

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

### @flatfile/plugin-delimiter-extractor 需要什么版本的 Node\.js？

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

### @flatfile/plugin-delimiter-extractor 可以商用吗？

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

### @flatfile/plugin-delimiter-extractor 的下载量有多少？

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

### @flatfile/plugin-delimiter-extractor 还在维护吗？

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