README.md

egg-acr

基于 acr 开发的异步验证组件。

安装

$ npm i egg-acr

使用

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

配置

// {app_root}/config/config.default.js
exports.acr = {
    lang: 'zh-cn',
};

查看 acr#配置 获取更多配置信息。

除了 acr 自带的配置外，插件还提供了一个 rules 参数用于自定义验证规则。

// {app_root}/config/config.default.js
exports.acr = {
    lang: 'zh-cn',
    rules: (acr, { app, ctx }) => {
        acr.type('string')
            .define('test', value => {
                return value === 'abel';
            });
    }
};

示例

// 在控制器的方法中

const { ctx, app: { acr } } = this;
const { name } = await ctx.validate({
    name: acr.string('昵称').required().equal('abel'),
});

更详细的例子可以参考：测试用例

了解 acr 才能更好的使用此组件，相关信息请移步 acr

问题和建议

请到 Issues 提问交流.

License

MIT