class-validator 技术文档

1. 安装指南

1.1 安装方式

要安装 class-validator，请在终端中运行以下命令：

npm install class-validator --save

1.2 注意事项

• npm 版本要求：请确保使用至少 npm@6 版本，因为从 npm@6 开始，依赖树是扁平化的，这是 class-validator 正常运行所必需的。

2. 项目使用说明

2.1 基本使用

class-validator 允许使用装饰器和非装饰器方式进行验证。内部使用 validator.js 进行验证。class-validator 可以在浏览器和 Node.js 平台上运行。

2.2 创建验证类

首先，创建一个类并在需要验证的属性上添加验证装饰器：

import {
  validate,
  validateOrReject,
  Contains,
  IsInt,
  Length,
  IsEmail,
  IsFQDN,
  IsDate,
  Min,
  Max,
} from 'class-validator';

export class Post {
  @Length(10, 20)
  title: string;

  @Contains('hello')
  text: string;

  @IsInt()
  @Min(0)
  @Max(10)
  rating: number;

  @IsEmail()
  email: string;

  @IsFQDN()
  site: string;

  @IsDate()
  createDate: Date;
}

2.3 验证实例

创建一个 Post 实例并进行验证：

let post = new Post();
post.title = 'Hello'; // 不符合长度要求
post.text = 'this is a great post about hell world'; // 不符合包含字符串要求
post.rating = 11; // 不符合数值范围要求
post.email = 'google.com'; // 不符合邮箱格式要求
post.site = 'googlecom'; // 不符合域名格式要求

validate(post).then(errors => {
  if (errors.length > 0) {
    console.log('验证失败，错误信息: ', errors);
  } else {
    console.log('验证成功');
  }
});

validateOrReject(post).catch(errors => {
  console.log('Promise 被拒绝（验证失败），错误信息: ', errors);
});

3. 项目 API 使用文档

3.1 validate 方法

validate 方法用于验证对象，返回一个包含 ValidationError 对象的数组。

validate(object: object, options?: ValidatorOptions): Promise<ValidationError[]>

3.2 validateOrReject 方法

validateOrReject 方法用于验证对象，如果验证失败，则拒绝 Promise。

validateOrReject(object: object, options?: ValidatorOptions): Promise<void>

3.3 ValidationError 对象

ValidationError 对象包含以下属性：

{
    target: Object; // 被验证的对象
    property: string; // 未通过验证的对象属性
    value: any; // 未通过验证的值
    constraints?: { // 未通过验证的约束及其错误信息
        [type: string]: string;
    };
    children?: ValidationError[]; // 包含属性的所有嵌套验证错误
}

3.4 ValidatorOptions 选项

validate 方法的第二个参数是 ValidatorOptions 对象，包含以下选项：

export interface ValidatorOptions {
  skipMissingProperties?: boolean;
  whitelist?: boolean;
  forbidNonWhitelisted?: boolean;
  groups?: string[];
  dismissDefaultMessages?: boolean;
  validationError?: {
    target?: boolean;
    value?: boolean;
  };
  forbidUnknownValues?: boolean;
  stopAtFirstError?: boolean;
}

4. 项目安装方式

4.1 使用 npm 安装

npm install class-validator --save

4.2 注意事项

• npm 版本要求：请确保使用至少 npm@6 版本，因为从 npm@6 开始，依赖树是扁平化的，这是 class-validator 正常运行所必需的。

通过以上文档，您可以详细了解 class-validator 的安装、使用和 API 调用方式。希望这份文档能帮助您更好地使用该项目。