# sails-hook-req-validate-promise
> Validations in Sailsjs requests
Latest version **1.7.1** (published 2019-01-15) · MIT license · 0 weekly downloads
## Install
```sh
npm install sails-hook-req-validate-promise
pnpm add sails-hook-req-validate-promise
yarn add sails-hook-req-validate-promise
bun add sails-hook-req-validate-promise
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.7.1 |
| Published | 2019-01-15 |
| First published | 2018-01-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 82.2 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | John Kim @johnkimdev |
| Maintainers | johnkimdev |
| Keywords | sails-hook, sails, sails.js, hook, req-validate, request-validate, req-validator, request-validator, req-validation, request-validation, validator, validation, validate |
## Links
- npm: https://www.npmjs.com/package/sails-hook-req-validate-promise
- Repository: https://github.com/JohnKimDev/sails-hook-req-validate-promise
- Issues: https://github.com/JohnKimDev/sails-hook-req-validate-promise/issues
- npm.io page: https://npm.io/package/sails-hook-req-validate-promise
## Dependencies (1)
- [validator](https://npm.io/package/validator.md) ^3.26.0
## Alternatives
- [@regle/core](https://npm.io/package/@regle/core.md) — 47.0K weekly downloads
- [typeof-arguments](https://npm.io/package/typeof-arguments.md) — 12.5K weekly downloads
- [@lokalise/projects-engine-contracts](https://npm.io/package/@lokalise/projects-engine-contracts.md) — 978 weekly downloads
- [@osjwnpm/nam-laboriosam-quibusdam](https://npm.io/package/@osjwnpm/nam-laboriosam-quibusdam.md) — 70 weekly downloads
- [@oridune/validator](https://npm.io/package/@oridune/validator.md) — 16 weekly downloads
## Recent versions
- 1.7.1 (latest) — 2019-01-15
- 1.7.0 — 2019-01-15
- 1.6.1 — 2019-01-10
- 1.6.0 — 2019-01-10
- 1.5.2 — 2019-01-10
- 1.5.1 — 2019-01-10
- 1.5.0 — 2019-01-10
- 1.4.5 — 2018-12-21
- 1.4.4 — 2018-12-17
- 1.4.3 — 2018-12-04
- 1.4.2 — 2018-12-04
- 1.4.1 — 2018-11-30
- 1.4.0 — 2018-11-29
- 1.3.1 — 2018-11-21
- 1.3.0 — 2018-11-21
- … 10 more at https://npm.io/package/sails-hook-req-validate-promise/versions
## README
# [DEPRECATION NOTICE]
## sails-hook-req-validate-promise
## Please use [sails-hook-req-validate](https://www.npmjs.com/package/sails-hook-req-validate) for the updated version! There is a brand new version that supports both PROMISE and Non-PROMISE versions with many new features.
I will no longer support this package but I will continue to update the [sails-hook-req-validate](https://www.npmjs.com/package/sails-hook-req-validate) package.
---
---
Sails hook for overwrite req.validate request with Promise.
Non-Promise version: https://www.npmjs.com/package/sails-hook-req-validate
```javascript
npm install sails-hook-req-validate-promise --save
```
### req.validate();
> ##### Requirements:
Sails v1.x.x and lodash enabled as global (lodash is enabled by default).
---
### Default Value (when a parameter is not set)
```javascript
const params = await req.validate(['fruit', ['string', {default: 'apple'}]); // if 'fruit' doesn't exists, it will be set as 'apple'
console.log(params);
```
```javascript
const params = await req.validate([
{'fruit', {enum: ['apple', 'organe', 'bannana'], default: 'apple'}}, // also can be used with enum
{'username?', 'string' }
]);
console.log(params);
```
---
### Enumeration check
```javascript
const params = await req.validate('fruit', {enum: ['apple', 'organe', 'bannana']});
console.log(params);
```
```javascript
const params = await req.validate([
{'fruit', {enum: ['apple', 'organe', 'bannana']}},
{'username?', 'string' },
{'nickname?', 'any' } // any type
]);
console.log(params);
```
```javascript
const params = await req.validate([
{'fruit', ['string', {enum: ['apple', 'organe', 'bannana']}]},
{'username?', 'string' }
]);
console.log(params);
```
---
### Simple Single & Multple Parameter(s)
Validates `req.params` for expecting parameter keys and returns `req.badRequest` (400 status code) if any parameter key is missing.
```javascript
try {
const params = await req.validate('id');
console.log(params); // {id: '1234'}
// if the validation fails, "req.badRequest" will be called and returns Promise.reject
} catch (err) {
// wil catch Promise.reject here.
}
```
If you prefer non async-await promise method
```javascript
req.validate('id');
.then(params => {
console.log(params); // {id: '1234'}
})
.catch(err => {
console.error(err);
});
```
Disable `req.badRequest` on error and enable `Promise.reject`
```javascript
const params = await req.validate('id', false); // <--- if you set the second value as FALSE, req.badRequest will NOT be call when error but it will just return Promise.reject
```
NOTE: To disable the default error response, set `false` as the second passing variable.
```javascript
const params = await req.validate(['id', 'firstname', 'lastname']);
console.log(params); // {id: '1234', firstname: "John", lastname: "Doe"}
// if the validation fails, "req.badRequest" will be called and returns Promise.reject
```
### Optional Parameter
Validates `req.params` for expecting parameter keys and returns `req.badRequest` (400 status code) if any parameter key is missing except optional parameters.
```javascript
const params = await req.validate(['id', 'firstname', 'lastname?']); // lastname is an OPTIONAL field
console.log(params); // {id: '1234', firstname: "John", lastname: "Doe"}
// if the validation fails, "req.badRequest" will be called and returns Promise.reject
```
NOTE: For an optional parameter, just add `?` at the end of the passing parameter key.
### Multple Parameters with TYPE filters
Validates `req.params` for expecting parameter keys and returns `req.badRequest` (400 status code) if any missing parameter key.
```javascript
const params = await req.validate([
{'id' : 'numeric'},
{'firstname' : 'string'},
{'lastname' : 'string'}
]);
console.log(params); // {id: '1234', firstname: "John", lastname: "Doe"}
```
See [Validation Filters](#validation_filters) for more information.
### OR Operation
OR `|` operarion is a new addition to 0.2.x version. It can be applied to either *required* or *optional* parameter.
```javascript
const params = await rreq.validate(
{'id': 'string | numeric'}, // 'numeric | string', 'numeric|string' or 'numeric| string' are OK. Space will be ignored
{'usernameOrEmail': 'string | numeric | email'}
);```
### Multple Parameters with TYPE filters & CONVERTION filters
Validates `req.params` for expecting parameter keys and returns `req.badRequest` (400 status code) if any missing parameter key.
```javascript
const params = await rreq.validate([
{'id' : 'numeric'},
{'firstname' : ['string', 'toUppercase']},
{'lastname' : ['string', 'toLowercase']}
]);
console.log(params); // {id: '1234', firstname: "John", lastname: "Doe"}
```
NOTE: All CONVERTION filters start with `to`, for example: toUppercase, toBoolean.
See [Validation Filters](#validation_filters) and [Conversion Filters](#conversion_filters) for more information.
### - Additional Example (Combining All Above Examples in One)
Validates `req.params` for expecting parameter keys and returns `req.badRequest` (400 status code) if any missing parameter key.
```javascript
const params = await req.validate([
{'id' : 'numeric'}, // (required) 'id' param as NUMERIC type
'phone?', // (optional) 'phone' as ANY type
{'website?': 'url'}, // (optional) 'website' as URL type
{'firstname' : ['string', 'toUppercase']}, // (required) 'firstname' as STRING type and convert to UPPERCASE
{'department' : ['string', 'lowercase']} // (required) 'department' as STRING type and must be LOWERCASE input
]);
console.log(params); // {id: '1234', firstname: "John", lastname: "Doe"}
// if the validation fails, "req.badRequest" will be called and will NOT returns Promise.reject
```
See [Validation Filters](#validation_filters) and [Conversion Filters](#conversion_filters) for more information.
### Disable Default Error Response
When the validation fails, `res.badRequest` will not be sent instead 'false' will be returned.
```javascript
try {
const params = await req.validate(
['id', 'firstname', 'lastname?'], // lastname is an OPTIONAL field
false // <--- if you set the second value as FALSE, req.badRequest will NOT be call "res.badRequest" response when error but it will return Promise.reject
);
console.log(params); // {id: '1234', firstname: "John", lastname: "Doe"}
// ..process
} catch (err) {
console.error(err);
return res.badRequest(); // Make sure to handle badRequest response
}
```
NOTE: To disable the default error response, set `false` as the second passing variable.
### Validation Filters
```javascript
any
email
url
ip
alpha
numeric
base64
hex
hexColor
lowercase
uppercase
string
boolean
int
float
date
json
array
object
ascii
mongoId
alphanumeric
creditCard
```
### Conversion Filters
```javascript
toLowercase
toUppercase
toEmail // Normalize email string
toBoolean
toDate
toInt
toFloat
```
---
_Source: https://npm.io/package/sails-hook-req-validate-promise · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._