@flatfile/plugin-validate-date

中文文档
0.3.1发布于 2025/01/10ISCTypeScriptESM + CJS近 30 天下载 1.6万

用于规范日期格式的平面文件插件

中文使用文档
文档目录5 节
  1. 参数
  2. 使用量
  3. 导入
  4. 示例使用
  5. 页:1

这个 @flatfile/plugin-validate-date 插件为Flatfile提供日期格式正常化功能. 它检测出各种日期格式并转换为指定的输出格式,支持多个字段和地块.

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

参数

config.sheetSlug - 说吧 string - 说吧 default: ** - (可选)

这个 sheetSlug 参数是工作表的 sattle 以应用规范化器。 如果不提供,它将适用于所有工作表.

config.dateFields - 说吧 string[]

这个 dateFields 参数是一个字段名称阵列,其中包含需要规范的日期值.

config.outputFormat - 说吧 string

这个 outputFormat 参数指定了正常化日期的预期输出格式.

config.includeTime - 说吧 boolean

这个 includeTime 参数决定是否将时间包含在正态输出中.

config.locale - 说吧 string - (可选)

这个 locale 参数指定用于日期解析的地方。 目前,仅支持"en-US".

使用量

npm install @flatfile/plugin-validate-date

导入

import { validateDate } from '@flatfile/plugin-validate-date'

示例使用

此示例为"接触"工作表设置了日期格式规范化器,将"出生日期"和"注册 日期"字段规范化为"MM/DD/YYYY"格式.

import { FlatfileListener } from '@flatfile/listener'
import { validateDate } from '@flatfile/plugin-validate-date'

export default function (listener: FlatfileListener) {
  listener.use(
    validateDate({
      sheetSlug: 'contacts',
      dateFields: ['birth_date', 'registration_date'],
      outputFormat: 'MM/dd/yyyy',
      includeTime: false
    })
  )
}

页:1

  • 该插件使用 chrono-node 用于解析日期的库,它支持广泛的日期格式.
  • 如果无法解析日期, 插件会在记录中为该字段添加一个错误消息 .
  • 这个 locale 参数包含在配置界面中,但目前在执行中并未使用. 插件默认使用“ en- US” 语言 .

版本与发布记录

@flatfile/plugin-validate-date 共发布 6 个版本,首次发布于 2024/10/10;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.3.1latest2025/01/101.8 年前
0.3.02024/11/082 年前
0.2.02024/10/302 年前
0.1.12024/10/292 年前
0.1.02024/10/112 年前
0.0.02024/10/102 年前

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

@flatfile/plugin-validate-date 是什么?

用于规范日期格式的平面文件插件

如何安装 @flatfile/plugin-validate-date?

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

@flatfile/plugin-validate-date 支持 TypeScript 吗?

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

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

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

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

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

@flatfile/plugin-validate-date 可以商用吗?

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

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

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

@flatfile/plugin-validate-date 还在维护吗?

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