Class-async-validate NPM

`class-async-validate`

基于async-validator库实现的一个通过定义类的方式来进行场景以及普通校验的类库。

安装

npm install class-async-validate

# 或
yarn add class-async-validate

使用

TS使用方式

创建一个类文件UserValidate

import { BaseValidate, Scenes, ValidateRules } from 'class-async-validate';

export default class UserValidate extends BaseValidate {
    /**
     * 验证规则部分
     */
    rules():ValidateRules {
        return {
            username: [
                { type: 'string', required: true, message: '账号不能为空' },
                { max: 10, min: 6, message: '账号必须在6-10位之间' },
            ],
            password: [
                { type: 'string', required: true, message: '密码不能为空' },
            ],
        };
    }

    /**
     * 验证场景部分
     */
    scenes():Scenes {
        return {
            create: [ 'username' ],
        };
    }
}

在egg中的使用方式如下,其他的如express、koa中的使用方式雷同

import { Controller } from 'egg';
import UserValidate from '../validate/user';

export default class HomeController extends Controller {
  public async index() {
    const { ctx } = this;
    const validator = new UserValidate();
    const [ err, res ] = await validator.setScene('create').check(ctx.request.query);
    console.log(res, JSON.stringify(err));
  }
}

自定义一个异步处理规则

import { BaseValidate, ValidateRules, Scenes, CallbackMessage } from 'class-async-validate';

export default class LoginValidate extends BaseValidate {
  rules(): ValidateRules {
    return {
      phone: {
        type: 'string',
        asyncValidator: this.phone,
      },
    };
  }

  scenes(): Scenes {
    return {

    };
  }

  async phone(rule:ValidateRules, value) {
    console.log(value, rule);
    new CallbackMessage('错误了，你看看');
  }
}

JS使用方式

创建一个UserValidate.js的文件

'use strict';
const { BaseValidate,CallbackMessage } = require('class-async-validate');
class UserValidate extends BaseValidate {
  rules() {
    return {
      id: { type: 'number', required: true, message: 'id只能是数字' },
      username: { type: 'string', required: true, message: '用户名不能为空' },
      password: [
        { type: 'string', required: true, message: '密码不能为空' },
        { min: 6, max: 20, message: '密码只能在6到20位之间' },
      ],
        phone:{type:'string',asyncValidator:this.phone}
    };
  }

scenes() { return { create: 'username', 'password' , update: 'id', 'username', 'password' , }; }

// 自定义校验规则 phone(rule,value){ if (value.length < 11){ new CallbackMessage("手机号格式不正确") } return true; } }

module.exports = UserValidate;

> 在`egg`中的使用方式如下，其他框架雷同。

```js
'use strict';

const Controller = require('egg').Controller;
const UserValidate = require('../validate/user/index');
class HomeController extends Controller {
  async index() {
    const { ctx } = this;
    const userValidate = new UserValidate();
    const [ err, res ] = await userValidate.setScene('create').check(ctx.request.query);
    console.log(err, JSON.stringify(res));
    ctx.body = 'hi, egg';
  }
}

module.exports = HomeController;