Neurosis Prevention Mechanism

    egg-validate
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.2 • Public • Published

    egg-validate

    NPM version build status Test coverage David deps Known Vulnerabilities npm download

    Validate plugin for egg.

    See parameter for more information such as custom rule.

    Install

    $ npm i egg-validate --save

    Usage

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

    Configurations

    egg-validate support all parameter's configurations, check parameter documents to get more infomations.

    // config/config.default.js
    exports.validate = {
      // convert: false,
      // validateRoot: false,
    };

    Validate Request Body

    // app/controller/home.js
    exports.index = function* () {
      this.validate({ id: 'id' }); // will throw if invalid
      // or
      const errors = this.app.validator.validate({ id: 'id' }, this.request.body);
    };

    Extend Rules

    • app.js
    app.validator.addRule('jsonString', (rule, value) => {
      try {
        JSON.parse(value);
      } catch (err) {
        return 'must be json string';
      }
    });

    Questions & Suggestions

    Please open an issue here.

    License

    MIT

    Install

    npm i egg-validate

    DownloadsWeekly Downloads

    58,219

    Version

    2.0.2

    License

    MIT

    Unpacked Size

    11.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • eggjs-admin
    • fengmk2
    • atian25
    • dead_horse
    • popomore
    • wanghx
    • hyj1991
    • killagu
    • coolme200
    • mansonchor.zzw
    • hubcarl