@flatfile/plugin-autocast

中文文档
7.0.0发布于 2025/01/10ISCTypeScriptESM + CJS近 30 天下载 2890

在 Flatfile 中自动显示值的插件 .

中文使用文档
文档目录7 节
  1. 参数
  2. API 调用
  3. 使用量
  4. 字符串
  5. 数字
  6. 布尔
  7. 日期

@ flatfile/ plugin- autocast

用此插件自动将 Flatfile 中的值投放到相应的类型 .

这个 @flatfile/plugin-autocast 插件是一个有见解的变压器,将 自动转换工作表中的数据,以匹配定义的类型 蓝图.

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

支持的字段类型 : number, (中文(简体) ), boolean, (中文(简体) ), date

参数

sheetSlug - 说吧 string - (必须)

这个 sheetSlug 表示要监视的工作表的 sult 名称.

fieldFilters - 说吧 string[]

使用 fieldFilters 参数来选择要监视的特定字段。 无 任何指定的 fieldFilters,插件将自动显示 包括字符串、数字、布林和日期.

options.chunkSize - 说吧 default: "10_000" - 说吧 number

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

options.parallel - 说吧 default: "1" - 说吧 number

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

API 调用

  • api.sheets.get

使用量

这个 autocast 插件将监听 commit:created 事件和铸造的字符串、数字、图案, 和日期 适当的蓝图类型。 注意 recordHook 财务报告和审定财务报表 bulkRecordHook 插件 听到同一事件类型。 插件会按放入听器的顺序开火.

字符串

数字和布尔由字符串转换为各自的类型(即:, '1' 改为 1, (中文(简体) ), "true" 改为 true) (中文(简体) ).

数字

字符串编号( 即 '1'),字符串小数(即 '1.1'),和带逗号的字符串数字(即 '1,000'(中文(简体) ) 被解释为数字.

布尔

'1', (中文(简体) ), 'yes', (中文(简体) ), 'true', (中文(简体) ), 'on', (中文(简体) ), 't', (中文(简体) ), 'y',以及 1 被解释为真实价值.

'-1', (中文(简体) ), '0', (中文(简体) ), 'no', (中文(简体) ), 'false', (中文(简体) ), 'off', (中文(简体) ), 'f', (中文(简体) ), 'n', (中文(简体) ), 0, (中文(简体) ), -1 被解释为病态值.

日期

日期字符串和数字被设定为 UTC 字符串 。 譬如说, YYYY-MM-DD... 格式作为ISO 8601日期(UTC)处理,而其他格式则被视为本地时间并转换为世界协调时:

  • '2023-08-16' => 'Wed, 16 Aug 2023 00:00:00 GMT'
  • '08-16-2023' => 'Wed, 16 Aug 2023 00:00:00 GMT'
  • '08/16/2023' => 'Wed, 16 Aug 2023 00:00:00 GMT'
  • 'Aug 16, 2023' => 'Wed, 16 Aug 2023 00:00:00 GMT'
  • 'August 16, 2023' => 'Wed, 16 Aug 2023 00:00:00 GMT'
  • '2023-08-16T00:00:00.000Z' => 'Wed, 16 Aug 2023 00:00:00 GMT'
  • 1692144000000 => 'Wed, 16 Aug 2023 00:00:00 GMT'

安装

npm i @flatfile/plugin-autocast

导入

import { autocast } from "@flatfile/plugin-autocast";

听众.js

listener.use(autocast("sheetSlug"));

收听器.js w/ 字段过滤器

listener.use(autocast("sheetSlug", ["numberField", "dateField"]));

收听器.js w/ 字段过滤器选项( S)

listener.use(
  autocast("sheetSlug", ["numberField", "dateField"], {
    chunkSize: 10_000,
    parallel: 2,
  })
);

版本与发布记录

@flatfile/plugin-autocast 共发布 42 个版本,首次发布于 2023/04/27;过去 12 个月发布了 0 个版本。

版本发布日期距今
7.0.0latest2025/01/101.8 年前
6.0.12024/12/111.9 年前
6.0.02024/11/192 年前
5.0.02024/11/082 年前
4.0.02024/11/012 年前
3.0.02024/10/302 年前

关于 @flatfile/plugin-autocast 的常见问题

@flatfile/plugin-autocast 是什么?

在 Flatfile 中自动显示值的插件 .

如何安装 @flatfile/plugin-autocast?

在项目目录运行 npm install @flatfile/plugin-autocast,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@flatfile/api(^1.9.19)、@flatfile/listener(^1.1.0)、@flatfile/plugin-record-hook(^2.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@flatfile/plugin-autocast 支持 TypeScript 吗?

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

@flatfile/plugin-autocast 支持 ESM 还是 CommonJS?

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

@flatfile/plugin-autocast 需要什么版本的 Node.js?

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

@flatfile/plugin-autocast 可以商用吗?

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

@flatfile/plugin-autocast 的下载量有多少?

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

@flatfile/plugin-autocast 还在维护吗?

最新版本 7.0.0 发布于 2025/01/10(1.8 年前);至今共发布 42 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/04/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。