`javascript
req.validate('id', (err, params) => {
// callback
if (err) { // err object is the output of onErrorOutput
sails.log.error('The validation failed.', err.message);
} else {
sails.log.info(params.id); // callback data
}
});
`

---

USAGE (asynchronous) - PROMISE

ES5 Promise
`javascript
req.validate('id', {
usePromise: true
})
.then(params => {
// callback
sails.log.info(params.id); // forwarded parameters if the validation passes
})
.catch(err => {
sails.log.error(err); // err object is the output of onErrorOutput
});
`
ES6 Async/Await Promise
`javascript
try {
const params = await req.validate('id', {
usePromise: true // or use the global setting
});
sails.log.info(params.id);
catch (err) {
sails.log.error(err); // err object is the output of onErrorOutput
}
`
---

My Personal Favorite Usage Method

// in someController.js
module.exports = {
index: async (req, res) => {
try {
const params = await req.validate({
'id': 'string',
'name': 'string'
});
console.log(params.id, params.name);
return res.ok();
} catch (err) {
return res.serverError(err);
}
}
};
`

---



Setting Options / Configurations

Option | Description
--------------------------------------- | --------------------------------------
responseMethod | ((function)) method/function to call when a validation error occurs

default: res.badRequest

@param errorOutput : output from onErrorOutput option
sendResponse | ((boolean)) toggle the responseMethod call when a validation error occurs

default: true
usePromise | ((boolean)) enable PROMISE response instead of callback

default: false
returnAllParams | ((boolean)) if ther are more passing params than listed in the req.validate, you can choose to pass-though all or filter to only listed params.

default: true
onErrorOutput | ((function)) when a validation error occurs, it will be called to generate the error output

default: see above config/validation.js example

@param errMessage ((string)): combined error message(s)
@param invalidKeys ((string[])): list of invalid param keys
@return : any form you want
requiredErrorMessage | ((function)) output message for param required error message

default: see above config/validation.js example

@param keys ((string \| string[])): list of invalid param key(s).
@return ((string)): formated error messgae as string type
formatErrorMessage | ((function)) output message for a validator format error message for param key

default: see above config/validation.js example

@param key ((string)): invalid param key.
@param typeMessage ((string)): type error message, see message for each type of the validationType file
@return ((string)): formated error messgae as string type
typeErrorMessage | ((function)) output message for a parm type error message

default: see above config/validation.js example

@param key ((string)): invalid param key.
@param typeMessage ((string)): type error message, see message for each type of the validationType file
@return ((string)): formated error messgae as string type
inputErrorMessage | ((function)) output message for a parm input error message

default: see above config/validation.js example

@param key ((string)): invalid param key.
@param typeMessage ((string)): type error message, see message for each type of the validationType file
@return ((string)): formated error messgae as string type
orInputErrorMessage | ((function)) output message for a parm input error message with OR opertation. The error message for each OR validation wil be combined

default: see above config/validation.js example

@param orKey ((string)): invalid OR param key. (ex: 'string\|email')
@param orTypeMessage ((string)): combined type error messages, see message for each type of the validationType file
@return ((string)): formated error messgae as string type

---



Validators

List of preset available validators.

NOTE: all validators are case insensitive

Validator | Description
--------------------------------------- | --------------------------------------
alpha | check if the string contains only letters (a-zA-Z).
alphanumeric | check if the string contains only letters and numbers.
ascii | check if the string contains ASCII chars only.
array | check if the value is array format. The validator uses lodash _.isArray to validate the type.
any | return true for any type except undefined.
base64 | check if a string is base64 encoded.
bolean | check if a string is a boolean.
byteLength | check if the string's length (in UTF-8 bytes) falls in a range.
creditcard | check if the string is a credit card.
currency | check if the string is a valid currency amount. Currency symbol is optional.
currencyWithSymbol | check if the string is a valid currency amount. Currency symbol is required.
dataURI | check if the string is a data uri format.
magnetURI | check if the string is a magnet uri format.
email | check if the string is an valid email address.
FQDN | check if the string is a fully qualified domain name (e.g. domain.com)
float | check if the string is a float.
hash | check if the string is a hash of type algorithm.

Algorithm is one of ['md4', 'md5', 'sha1', 'sha256', 'sha384', 'sha512', 'ripemd128', 'ripemd160', 'tiger128', 'tiger160', 'tiger192', 'crc32', 'crc32b']
hexColor | check if the string is a hexadecimal color.
hexadecimal | check if the string is a hexadecimal number.
ip | check if the string is an IP (either version 4 or 6).
ipv4 | check if the string is an IP version 4 only).
ipv6 | check if the string is an IP version 6 only.
ISBN | check if the string is an ISBN (either version 10 or 13).
ISBN10 | check if the string is an ISBN version 10 only.
ISBN13 | check if the string is an ISBN version 13 only.
ISSN | check if the string is an ISSN.
ISIN | check if the string is an [ISIN][ISIN] (stock/security identifier).
ISO8601 | check if the string is a valid ISO 8601 date
RFC3339 | check if the string is a valid RFC 3339 date.
ISO31661Alpha2 | check if the string is a valid ISO 3166-1 alpha-2 officially assigned country code.
ISO31661Alpha3 | check if the string is a valid ISO 3166-1 alpha-3 officially assigned country code.
ISRC | check if the string is a ISRC.
int | check if the string is an integer.

Built-In Converter: int
JSON | check if the string is valid JSON(note: uses JSON.parse).
JWT | check if the string is valid JWT token.
LatLong | check if the string is a valid latitude-longitude coordinate in the format lat,long or lat, long.
lowercase | check if the string is lowercase.
MACAddress | check if the string is a MAC address.
MD5 | check if the string is a MD5 hash.
MimeType | check if the string matches to a valid MIME type format
mobilePhone | check if the string is a mobile phone number (all locales).
mobilephone-ar-AE | check if the string is a mobile phone number of ar-AE locale
mobilephone-ar-DZ | check if the string is a mobile phone number of ar-DZ locale
mobilephone-ar-EG | check if the string is a mobile phone number of ar-EG locale
mobilephone-ar-IQ | check if the string is a mobile phone number of ar-IQ locale
mobilephone-ar-JO | check if the string is a mobile phone number of ar-JO locale
mobilephone-ar-KW | check if the string is a mobile phone number of ar-KW locale
mobilephone-ar-SA | check if the string is a mobile phone number of ar-SA locale
mobilephone-ar-SY | check if the string is a mobile phone number of ar-SY locale
mobilephone-ar-TN | check if the string is a mobile phone number of ar-TN locale
mobilephone-be-BY | check if the string is a mobile phone number of be-BY locale
mobilephone-bg-BG | check if the string is a mobile phone number of bg-BG locale
mobilephone-bn-BD | check if the string is a mobile phone number of bn-BD locale
mobilephone-cs-CZ | check if the string is a mobile phone number of cs-CZ locale
mobilephone-de-DE | check if the string is a mobile phone number of de-DE locale
mobilephone-da-DK | check if the string is a mobile phone number of da-DK locale
mobilephone-el-GR | check if the string is a mobile phone number of el-GR locale
mobilephone-en-AU | check if the string is a mobile phone number of en-AU locale
mobilephone-en-CA | check if the string is a mobile phone number of en-CA locale
mobilephone-en-GB | check if the string is a mobile phone number of en-GB locale
mobilephone-en-GH | check if the string is a mobile phone number of en-GH locale
mobilephone-en-HK | check if the string is a mobile phone number of en-HK locale
mobilephone-en-IE | check if the string is a mobile phone number of en-IE locale
mobilephone-en-IN | check if the string is a mobile phone number of en-IN locale
mobilephone-en-KE | check if the string is a mobile phone number of en-KE locale
mobilephone-en-MU | check if the string is a mobile phone number of en-MU locale
mobilephone-en-NG | check if the string is a mobile phone number of en-NG locale
mobilephone-en-NZ | check if the string is a mobile phone number of en-NZ locale
mobilephone-en-RW | check if the string is a mobile phone number of en-RW locale
mobilephone-en-SG | check if the string is a mobile phone number of en-SG locale
mobilephone-en-UG | check if the string is a mobile phone number of en-UG locale
mobilephone-en-US | check if the string is a mobile phone number of en-US locale
mobilephone-en-TZ | check if the string is a mobile phone number of en-TZ locale
mobilephone-en-ZA | check if the string is a mobile phone number of en-ZA locale
mobilephone-en-ZM | check if the string is a mobile phone number of en-ZM locale
mobilephone-en-PK | check if the string is a mobile phone number of en-PK locale
mobilephone-es-ES | check if the string is a mobile phone number of es-ES locale
mobilephone-es-MX | check if the string is a mobile phone number of es-MX locale
mobilephone-es-UY | check if the string is a mobile phone number of es-UY locale
mobilephone-et-EE | check if the string is a mobile phone number of et-EE locale
mobilephone-fa-IR | check if the string is a mobile phone number of fa-IR locale
mobilephone-fi-FI | check if the string is a mobile phone number of fi-FI locale
mobilephone-fr-FR | check if the string is a mobile phone number of fr-FR locale
mobilephone-he-IL | check if the string is a mobile phone number of he-IL locale
mobilephone-hu-HU | check if the string is a mobile phone number of hu-HU locale
mobilephone-it-IT | check if the string is a mobile phone number of it-IT locale
mobilephone-ja-JP | check if the string is a mobile phone number of ja-JP locale
mobilephone-kk-KZ | check if the string is a mobile phone number of kk-KZ locale
mobilephone-ko-KR | check if the string is a mobile phone number of ko-KR locale
mobilephone-lt-LT | check if the string is a mobile phone number of lt-LT locale
mobilephone-ms-MY | check if the string is a mobile phone number of ms-MY locale
mobilephone-nb-NO | check if the string is a mobile phone number of nb-NO locale
mobilephone-nn-NO | check if the string is a mobile phone number of nn-NO locale
mobilephone-pl-PL | check if the string is a mobile phone number of pl-PL locale
mobilephone-pt-PT | check if the string is a mobile phone number of pt-PT locale
mobilephone-pt-BR | check if the string is a mobile phone number of pt-BR locale
mobilephone-ro-RO | check if the string is a mobile phone number of ro-RO locale
mobilephone-ru-RU | check if the string is a mobile phone number of ru-RU locale
mobilephone-sl-SI | check if the string is a mobile phone number of sl-SI locale
mobilephone-sk-SK | check if the string is a mobile phone number of sk-SK locale
mobilephone-sr-RS | check if the string is a mobile phone number of sr-RS locale
mobilephone-sv-SE | check if the string is a mobile phone number of sv-SE locale
mobilephone-th-TH | check if the string is a mobile phone number of th-TH locale
mobilephone-tr-TR | check if the string is a mobile phone number of tr-TR locale
mobilephone-uk-UA | check if the string is a mobile phone number of uk-UA locale
mobilephone-vi-VN | check if the string is a mobile phone number of vi-VN locale
mobilephone-zh-CN | check if the string is a mobile phone number of zh-CN locale
mobilephone-zh-HK | check if the string is a mobile phone number of zh-HK locale
mobilephone-zh-TW | check if the string is a mobile phone number of zh-TW locale
mongoId | check if the string is a valid hex-encoded representation of a [MongoDB ObjectId][mongoid].
multibyte | check if the string contains one or more multibyte chars.
numeric | check if the string contains only numbers. Some symbols are allow (e.g. +, -, or .).
numericOnly | check if the string contains only numbers [0-9]. No symbol allow.
number | same as numeric
object | check if value is a plain object. The validator uses lodash _.isPlainObject to validate the type.
port | check if the string is a valid port number.
postalCode | check if the string is a postal code (all locales).
postalCode-AD | check if the string is a postal code of AD
postalCode-AT | check if the string is a postal code of AT
postalCode-AU | check if the string is a postal code of AU
postalCode-BE | check if the string is a postal code of BE
postalCode-BG | check if the string is a postal code of BG
postalCode-CA | check if the string is a postal code of CA
postalCode-CH | check if the string is a postal code of CH
postalCode-CZ | check if the string is a postal code of CZ
postalCode-DE | check if the string is a postal code of DE
postalCode-DK | check if the string is a postal code of DK
postalCode-DZ | check if the string is a postal code of DZ
postalCode-ES | check if the string is a postal code of ES
postalCode-FI | check if the string is a postal code of FI
postalCode-FR | check if the string is a postal code of FR
postalCode-GB | check if the string is a postal code of GB
postalCode-GR | check if the string is a postal code of GR
postalCode-IL | check if the string is a postal code of IL
postalCode-IS | check if the string is a postal code of IS
postalCode-IT | check if the string is a postal code of IT
postalCode-JP | check if the string is a postal code of JP
postalCode-KE | check if the string is a postal code of KE
postalCode-LI | check if the string is a postal code of LI
postalCode-MX | check if the string is a postal code of MX
postalCode-NL | check if the string is a postal code of NL
postalCode-NO | check if the string is a postal code of NO
postalCode-PL | check if the string is a postal code of PL
postalCode-PT | check if the string is a postal code of PT
postalCode-RO | check if the string is a postal code of RO
postalCode-RU | check if the string is a postal code of RU
postalCode-SA | check if the string is a postal code of SA
postalCode-SE | check if the string is a postal code of SE
postalCode-TW | check if the string is a postal code of TW
postalCode-US | check if the string is a postal code of US
postalCode-ZA | check if the string is a postal code of ZA
postalCode-ZM | check if the string is a postal code of ZM
surrogatePair | check if the string contains any surrogate pairs chars.
string | check if value is string. BE CAUTIOUS of using this type! May return invalid result. For the parameter values from a querystring and a URL path are always STRING type, using this validator type may have an unexpected result.
URL | check if the string is an URL. allow protocols 'http', 'https', 'ftp'.
UUID | check if the string is a UUID (version 3, 4 or 5).
UUIDv3 | check if the string is a UUID version 3
UUIDv4 | check if the string is a UUID version 4
UUIDv5 | check if the string is a UUID version 5
uppercase | check if the string is uppercase.



---



Converters

List of converters available.

NOTE: all converters are case insenstive

Converter | Description
-------------------------------------- | -------------------------------
boolean | convert the input string to a boolean. Everything except for '0', 'false' and '' returns true. In strict mode only '1' and 'true' return true.
date | convert the input string to a date, or null if the input is not a date.
escape | replace <, >, &, ', " and / with HTML entities.
unescape | replaces HTML encoded entities with <, >, &, ', " and /.
JSON | convert to JSON using JSON.parse
JSON5 | convert to JSON using JSON5.parse
ltrim | trim characters from the left-side of the input.
rtrim | trim characters from the right-side of the input.
removeHTML | strip HTML codes from the string
removeSpace | remove all white space from the string
removeLineBreak | remove all line breaks from the string, \r\n\t, \n, \t\t
normalizeEmail | canonicalizes an email address. (This doesn't validate that the input is an email, if you want to validate the email use email validator beforehand).
lowercase | convert to lower case
string | convert to string
int | convert the input string to an integer, or NaN if the input is not an integer.
float | convert the input string to a float, or NaN` if the input is not a float.
trim | trim characters (whitespace by default) from both sides of the input.
uppercase | convert to upper case