@flatfile/plugin-delimiter-extractor

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

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

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

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

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

参数

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 的已划定文件 。 然后平台会自动取出文件. 一旦完成,文件将准备在文件区域导入 .

npm i @flatfile/plugin-delimiter-extractor

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

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

完整示例

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

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.