Skip to content

Commit

Permalink
6.14.1
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavohenke committed May 22, 2022
1 parent 199fcf6 commit 82e4d84
Show file tree
Hide file tree
Showing 5 changed files with 103 additions and 2 deletions.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -7,7 +7,7 @@
"Gustavo Henke <[email protected]>",
"Federico Ciardi <[email protected]>"
],
"version": "6.14.0",
"version": "6.14.1",
"homepage": "https://express-validator.github.io",
"license": "MIT",
"repository": {
Expand Down
3 changes: 3 additions & 0 deletions website/i18n/en.json
Expand Up @@ -206,6 +206,9 @@
"version-6.13.0/version-6.13.0-schema-validation": {
"title": "Schema Validation"
},
"version-6.14.1/version-6.14.1-schema-validation": {
"title": "Schema Validation"
},
"version-6.2.0/version-6.2.0-validation-chain-api": {
"title": "Validation Chain API"
},
Expand Down
97 changes: 97 additions & 0 deletions website/versioned_docs/version-6.14.1/feature-schema-validation.md
@@ -0,0 +1,97 @@
---
id: version-6.14.1-schema-validation
title: Schema Validation
original_id: schema-validation
---

Schemas are a special, object-based way of defining validations or sanitizations on requests.
At the root-level, you specify field paths as keys, and objects as values -- which define
the error messages, locations and validations/sanitizations.

Its syntax looks like this:

```js
const { checkSchema, validationResult } = require('express-validator');
app.put(
'/user/:id/password',
checkSchema({
id: {
// The location of the field, can be one or more of body, cookies, headers, params or query.
// If omitted, all request locations will be checked
in: ['params', 'query'],
errorMessage: 'ID is wrong',
isInt: true,
// Sanitizers can go here as well
toInt: true,
},
myCustomField: {
// Custom validators
custom: {
options: (value, { req, location, path }) => {
return value + req.body.foo + location + path;
},
},
// and sanitizers
customSanitizer: {
options: (value, { req, location, path }) => {
let sanitizedValue;

if (req.body.foo && location && path) {
sanitizedValue = parseInt(value);
} else {
sanitizedValue = 0;
}

return sanitizedValue;
},
},
},
password: {
isLength: {
errorMessage: 'Password should be at least 7 chars long',
// Multiple options would be expressed as an array
options: { min: 7 },
},
},
firstName: {
isUppercase: {
// To negate a validator
negated: true,
},
rtrim: {
// Options as an array
options: [[' ', '-']],
},
},
// Support bail functionality in schemas
email: {
isEmail: {
bail: true,
},
},
// Support if functionality in schemas
someField: {
isInt: {
if: value => {
return value !== '';
},
},
},
// Wildcards/dots for nested fields work as well
'addresses.*.postalCode': {
// Make this field optional when undefined or null
optional: { options: { nullable: true } },
isPostalCode: {
options: 'US', // set postalCode locale here
},
},
}),
(req, res, next) => {
const errors = validationResult(req);
if (!errors.isEmpty()) {
return res.status(400).json({ errors: errors.array() });
}
// handle the request as usual
},
);
```
1 change: 1 addition & 0 deletions website/versions.json
@@ -1,4 +1,5 @@
[
"6.14.1",
"6.14.0",
"6.13.0",
"6.12.2",
Expand Down

0 comments on commit 82e4d84

Please sign in to comment.