# @flatfile/plugin-constraints 中文文档

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

版本：8\.0\.2
npm 元数据更新时间：2026-04-23T23:54:26.011Z
中文译文更新时间：2026-11-14T21:49:20.785Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：43.3 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：0 个
- peer 依赖：@flatfile/api ^1\.9\.19，@flatfile/listener ^1\.1\.0，@flatfile/plugin-record-hook ^2\.0\.0
- 首次发布：2024-01-29T18:45:23.426Z
- 最新版本发布：2025-02-28T17:46:48.981Z
- 近 30 天下载量：21681（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 0 个）

## 中文简介

外部限制扩展蓝图的插件

## 安装

```sh
npm install @flatfile/plugin-constraints
```

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

## README

# @ flatfile/ plugin- 约束

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

## 使用量

```ts
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
    }
  })
)
```

```js
// blueprint fields
[
  {
    key: 'name',
    type: 'string',
    constraints: [
      { type: 'external', validator: 'length', config: { max: 100 } }
    ]
  },
  {
    key: 'age',
    type: 'number',
  }
]
```

## 常见问题

### @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 和提交记录判断。