# @forwardslashns/taskit-validation-messages 中文文档

规范地址：https://npmcn.com/package/%40forwardslashns/taskit-validation-messages/

版本：1\.10\.111
npm 元数据更新时间：2026-11-13T19:31:12.226Z
中文译文更新时间：2026-11-15T10:16:47.084Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40forwardslashns/taskit-validation-messages
原文对照：https://npmcn.com/package/%40forwardslashns/taskit-validation-messages/?lang=original
项目主页：https://github.com/fws-solutions/taskit-validation-messages#readme
源码仓库：https://github.com/fws-solutions/taskit-validation-messages

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

- 包体积（解压后）：565 kB，168 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：0 个
- 首次发布：2025-04-02T08:39:53.687Z
- 最新版本发布：2026-11-13T19:31:12.076Z
- 近 30 天下载量：3163（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：195（近 12 个月 131 个）

## 中文简介

用于 Taskit 的验证信件和动态读取这些信件的机制 .

## 安装

```sh
npm install @forwardslashns/taskit-validation-messages
```

也可以使用：`pnpm add @forwardslashns/taskit-validation-messages`、`yarn add @forwardslashns/taskit-validation-messages`、`bun add @forwardslashns/taskit-validation-messages`

## README

# 任务验证信件

此软件包提供了跨项目前端和后端使用的验证消息的集中列表. 它确保连贯的错误显示并简化维护,将所有验证信息保存在一个地方,而不改变开发库中的代码.

## \* 特性

-   **集中验证信息** 跨越所有特征
-   **类型安全** 使用 TypeScript 检索信件
-   **特征名称常数** 消除魔法字符串(v1.3.0+)
-   **信件密钥常数** 用于消除错误别名的魔法字符串(v1.3.1+)
-   **动态参数替换** 用于背景信息
-   **受影响的田地跟踪** 用于更好的前端 UX(v1.1.0+)

# 评估 纤维(v1.3.0+)

为了避免使用魔法字符串和改善类型安全,软件包现在输出 `VALIDATION_FEATURES` 常数 :

```typescript
import { getValidationMessage, VALIDATION_FEATURES } from '@forwardslashns/taskit-validation-messages';

// ✅ Recommended: Use constants
const result = getValidationMessage(VALIDATION_FEATURES.CLIENT_CURRENT_ENTITY_STATUS, 'NAME_ALREADY_EXISTS', {
  name: 'Client Name',
});

// ❌ Not recommended: Using string literals
const result = getValidationMessage('CLIENT_CURRENT_ENTITY_STATUS', 'NAME_ALREADY_EXISTS', { name: 'Client Name' });
```

### 可用的特性常数

```typescript
VALIDATION_FEATURES.ACCOUNT_CATEGORY;
VALIDATION_FEATURES.ACCOUNT_ID;
VALIDATION_FEATURES.CLIENT_RECORD_ADDRESS;
VALIDATION_FEATURES.BUSINESS_ACTIVITY;
VALIDATION_FEATURES.CLIENT_RECORD_BANK_AND_CREDIT_CARD;
VALIDATION_FEATURES.CLIENT_RECORD_CONTACT;
VALIDATION_FEATURES.CLIENT_RECORD_COMISSION_DETAIL;
VALIDATION_FEATURES.CLIENT_CURRENT_ENTITY_STATUS;
VALIDATION_FEATURES.CLIENT_RECORD_ENTITY_TYPE_HISTORY;
VALIDATION_FEATURES.CLIENT_RECORD_FILING_STATUS_HISTORY;
VALIDATION_FEATURES.CLIENT_RECORD_ENTITY_STATE_HISTORY;
VALIDATION_FEATURES.CLIENT_RELATIONSHIP;
VALIDATION_FEATURES.FILING_CATEGORY;
VALIDATION_FEATURES.STATE;
VALIDATION_FEATURES.USER;
VALIDATION_FEATURES.ROLE_AND_PERMISSION;
VALIDATION_FEATURES.DATA_FILTER;
VALIDATION_FEATURES.USER_PREFERENCE;
VALIDATION_FEATURES.CLIENT_RECORD_OUTSIDE_PROVIDER;
```

# 评估 内容

该套件会曝光可以使用特定别名取回的验证消息. 这些讯息按照所属的特性编排,从而更容易管理和更新.

# 获取变量

这种机制允许通过传递其别名和任何需要的参数来检索和动态生成验证消息. 参数是可选的,按照每个验证消息本身内所定义的结构作为对象传递.

## 返回值(v1.1.0+)

`getValidationMessage` 现在返回 a `ValidationMessageResult` 对象 :

```typescript
{
  content: string;          // The formatted validation message
  affectedFields: string[]; // Array of field identifiers affected by this validation error
}
```

## 使用量

```typescript
import { getValidationMessage, VALIDATION_FEATURES } from '@forwardslashns/taskit-validation-messages';

// ✅ Best practice: Use feature constants (v1.3.0+)
const result = getValidationMessage(VALIDATION_FEATURES.ACCOUNT_CATEGORY, 'NAME_ALREADY_EXISTS', { name: 'Marketing' });

// Also works: String literals (backward compatible)
const result2 = getValidationMessage('ACCOUNT_CATEGORY', 'NAME_ALREADY_EXISTS', {
  name: 'Marketing',
});

console.log(result.content); // "Account category with the same name 'Marketing' already exists"
console.log(result.affectedFields); // ['name']

// In API responses
return reply.status(400).send({
  message: result.content,
  affectedFields: result.affectedFields,
});
```

## 从v1.0.x迁移

见 [(原始内容存档于2017-09-25) (英语). Migaliation Guide.md](https://npmcn.com/package/%40forwardslashns/taskit-validation-messages/MIGRATION_GUIDE.md) 详细移民指示.

**快速更新 :**

```typescript
// Old (v1.0.x)
const message = getValidationMessage('FEATURE', 'ERROR');

// New (v1.1.0+)
const { content, affectedFields } = getValidationMessage('FEATURE', 'ERROR');
```

## 文档

-   [移徙指南](https://npmcn.com/package/%40forwardslashns/taskit-validation-messages/MIGRATION_GUIDE.md) - 从v1.0.x升级
-   [执行情况摘要](https://npmcn.com/package/%40forwardslashns/taskit-validation-messages/IMPLEMENTATION_SUMMARY.md) - 技术细节
-   [后端更新检查列表](https://npmcn.com/package/%40forwardslashns/taskit-validation-messages/BACKEND_UPDATE_CHECKLIST.md) - 逐步后端迁移
-   [示例使用](https://npmcn.com/package/%40forwardslashns/taskit-validation-messages/example-usage.ts) - 代码示例

## 常见问题

### @forwardslashns/taskit-validation-messages 是什么？

用于 Taskit 的验证信件和动态读取这些信件的机制 \.

### 如何安装 @forwardslashns/taskit-validation-messages？

在项目目录运行 npm install @forwardslashns/taskit-validation-messages，或使用 pnpm add / yarn add / bun add。

### @forwardslashns/taskit-validation-messages 支持 TypeScript 吗？

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

### @forwardslashns/taskit-validation-messages 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @forwardslashns/taskit-validation-messages 需要什么版本的 Node\.js？

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

### @forwardslashns/taskit-validation-messages 可以商用吗？

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

### @forwardslashns/taskit-validation-messages 的下载量有多少？

根据 npm 官方下载统计，@forwardslashns/taskit-validation-messages 在 2026/10/16 – 2026/11/14 这 30 天内被下载 3,163 次，日均约 105 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @forwardslashns/taskit-validation-messages 还在维护吗？

最新版本 1\.10\.111 发布于 2026/11/14（2 天前）；至今共发布 195 个版本，其中过去 12 个月发布了 131 个；首次发布于 2025/04/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。