Skip to content

This package adds the ability to Validators to enforce requests to contain only the fields present in the rules getter.

Notifications You must be signed in to change notification settings

jayrchamp/adonis-strict-validator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Adonis Strict Validator

This package adds the ability to Validators to enforce requests to contain only the fields present in the rules getter.

Getting Started

Install the package using the adonis CLI.

> adonis install @jayrchamp/adonis-strict-validator

Follow instruction that are displayed (or read them here).

Usage

Create a Validator file in App/Validators/ (ex.: App/Validators/Example) and set strict getter to true.

// App/Validators/Example/index.js

class ExampleValidator {
  
  /**
   * Deny requests containing an unspecified query string or body in the rules object
   */
  get strict () {
    return true
  }

  /**
   * Deny request without query string or body
   */
  get noEmpty () {
    return true
  }

  get rules () {
    return {
      gender: 'string'
    }
  }
}

module.exports = ExampleValidator
// Request body example
{
  gender: "male",
  pogo: "yolo"

}

// Response example
{
  code: "E_VALIDATION_FAILED",
  errors: [
    {
      message: "strict validation failed on field",
      field: "pogo",
      validation: "strict_fields"
    }
  ]
}

About

This package adds the ability to Validators to enforce requests to contain only the fields present in the rules getter.

Resources

Stars

Watchers

Forks

Packages

No packages published