@flatfile/plugin-constraints

中文文档
8.0.2发布于 2025/03/01ISCTypeScriptESM + CJS零依赖近 30 天下载 2.2万

外部限制扩展蓝图的插件

中文使用文档

@ flatfile/ plugin- 约束

这个插件引入了为蓝图注册外部约束的能力.

使用量

listener.use(
  externalConstraint('length', (value, key, { config, record }) => {
    if (value.length > config.max) {
      record.addError(key, `Text must be under ${config.max} characters`)
      // alternatively throw the error
    }
  })
)
// blueprint fields
[
  {
    key: 'name',
    type: 'string',
    constraints: [
      { type: 'external', validator: 'length', config: { max: 100 } }
    ]
  },
  {
    key: 'age',
    type: 'number',
  }
]

版本与发布记录

@flatfile/plugin-constraints 共发布 24 个版本,首次发布于 2024/01/30;过去 12 个月发布了 0 个版本。

版本发布日期距今
8.0.2latest2025/03/011.7 年前
8.0.12025/01/141.8 年前
8.0.02025/01/101.8 年前
7.0.02024/11/192 年前
6.0.02024/11/082 年前
5.0.02024/11/012 年前

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

@flatfile/plugin-constraints 是什么?

外部限制扩展蓝图的插件

如何安装 @flatfile/plugin-constraints?

在项目目录运行 npm install @flatfile/plugin-constraints,或使用 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-constraints 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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

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

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