Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ethan7g/verif
Secure data validation in JS
https://github.com/ethan7g/verif
data data-integrity data-structures data-validation data-validator js json nodejs
Last synced: 21 days ago
JSON representation
Secure data validation in JS
- Host: GitHub
- URL: https://github.com/ethan7g/verif
- Owner: ethan7g
- License: mit
- Created: 2019-04-02T06:00:13.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-02T03:22:39.000Z (over 5 years ago)
- Last Synced: 2024-12-07T20:34:37.405Z (about 1 month ago)
- Topics: data, data-integrity, data-structures, data-validation, data-validator, js, json, nodejs
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# verif
> Secure data validation in JS
[GitHub](https://github.com/ethanent/verif) | [NPM](https://www.npmjs.com/package/verif)
## Install
```
npm i verif
```
```js
const {Validator, Range} = require('verif')
```
## Usage
### Create a validator
```js
const myValidator = new Validator({
'type': 'object',
'props': {
'name': {
'type': 'string',
'length': Range(3, 23)
},
'age': {
'type': 'number',
'value': Range(5, 4000)
}
}
})
```
### Test with a validator
```js
myValidator.test({
'name': 'Tester',
'age': 17
})
// This will not throw; data is acceptable.
```
```js
myValidator.test({
'name': 'Tester',
'age': 4
})
// This will throw an error:
// Error: Number value 4 out of bounds. Expected in [5, 4000]
```
### Validate with a validator
```js
const res = myValidator.validate({
'name': 'Tester',
'age': 4
})
// This will return information about the validation:
/*
{
passed: false,
message: 'Number value 4 out of bounds. Expected in [5, 4000]',
path: '/age/'
}
*/
```
### Create a range
```js
// new Range(min: number, max: number, inclusive: boolean)
new Range(4, 7, false)
// Exclusive range (4, 7)
new Range(6, 10, true)
new Range (6, 10)
// Inclusive range [6, 10]
```
## Properties of types
For all validations, a `type` must be specified.
### number
- `Range` value
Permitted number value range
### string
- `Range` length
Permitted string length range
- `RegEx` test
Mandatory string regular expression test
### array
- `Range` length
Permitted array length range
- `schema` items
Schema for item testing
### object
- `Object[schema]` props
Schemas for testing individual properties
- `boolean` allowExtraProps
Permit the inclusion of additional properties not defined in `props`
Default: `false`