cocacms / egg-async-validator

egg-async-validator

egg-async-validate

Validate plugin for egg.

see async-validate for more information such as custom rule.

以中文查看

Install

$ npm i egg-async-validate --save

Usage

// {app_root}/config/plugin.js
exports.asyncValidator = {
  enable: true,
  package: 'egg-async-validate',
};

Configuration

// {app_root}/config/config.default.js
exports.asyncValidator = {
  messages: {},
};

see async-validator#messages for more detail.

Example

// {app_root}/app/controller/home.js
exports.index = async ctx => {

  // will throw if invalid.
  await ctx.validate({
    data: { type: 'object', required: true },
  }, {
    data: '1',
  });

  // if you want to get errors info,
  // use try { ... } catch (err) { ... } to get
  // example
  try {
    await ctx.validate({ data: { type: 'object', required: true } }); // validate target, default to `this.request.body`
  } catch (err) {
    const errors = err.errors;
  }

};

rules see async-validator#rules for more detail.

!!important: method,date,hex in type does not apply to server - side form validation

License

MIT