Giter VIP home page Giter VIP logo

egg-plugin-validate's Introduction

egg-plugin-validate

An egg plugin for validating parameters, Forked from egg-validate, And added two built-in custom rules for object and array

NPM version Codacy Badge Known Vulnerabilities npm download License

Sonar

See parameter for more information such as custom rule.

Install

# use pnpm
$ pnpm install egg-plugin-validate

# use yarn
$ yarn add egg-plugin-validate

Usage

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

Configurations

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

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

Validate Request Body

// {app_root}/app/controller/home.js
const { Controller } = require('egg')

class HomeController extends Controller {
  async index() {
    const { ctx, app } = this
    ctx.validate({ id: 'id' }) // will throw if invalid
    // or
    const errors = app.validator.validate({ id: 'id' }, ctx.request.body)
  }
}

module.exports = HomeController

Extend Rules

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

Change logs

Change logs

Questions & Suggestions

Please open an issue here.

License

MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.