@jayrchamp/adonis-strict-validator
v2.1.5
Published
This package adds the ability to Validators to enforce requests to contain only the fields present in the rules getter.
Downloads
9
Maintainers
Readme
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"
}
]
}