A cross-browser / node.js validator used by resourceful and flatiron. Revalidator has JSONSchema compatibility as primary goal.
The core of revalidator is simple and succinct: revalidator.validate(obj, schema):
``` js var revalidator = require('revalidator');
console.dir(revalidator.validate(someObject, { properties: { url: { description: 'the url the object should be stored at', type: 'string', pattern: '^/[^#%&*{}\:<>?\/+]+$', required: true }, challenge: { description: 'a means of protecting data (insufficient for production, used as example)', type: 'string', minLength: 5 }, body: { description: 'what to store at the url', type: 'any', default: null } } })); ```
This will return with a value indicating if the obj conforms to the schema. If it does not, a descriptive object will be returned containing the errors encountered with validation.
js
{
valid: true // or false
errors: [/* Array of errors if valid is false */]
}
In the browser, the validation function is exposed on window.validate by simply including revalidator.js.
bash
$ curl http://npmjs.org/install.sh | sh
bash
$ [sudo] npm install revalidator
revalidator takes json-schema as input to validate objects.
This will return with a value indicating if the obj conforms to the schema. If it does not, a descriptive object will be returned containing the errors encountered with validation.
js
{
valid: true // or false
errors: [/* Array of errors if valid is false */]
}
validateFormats is true treat unrecognized formats as validation errors (default false)validateFormats is true also validate formats defined in validate.formatExtensions (default true)"42" => 42, but "forty2" => "forty2" for the integer type.For a property an value is that which is given as input for validation where as an expected value is the value of the below fields
If true, the value should not be undefined
js
{ required: true }
If false, the value must not be an empty string
js
{ allowEmpty: false }
The type of value should be equal to the expected value
js
{ type: 'string' }
{ type: 'number' }
{ type: 'integer' }
{ type: 'array' }
{ type: 'boolean' }
{ type: 'object' }
{ type: 'null' }
{ type: 'any' }
{ type: ['boolean', 'string'] }
The expected value regex needs to be satisfied by the value
js
{ pattern: /^[a-z]+$/ }
The length of value must be greater than or equal to expected value
js
{ maxLength: 8 }
The length of value must be lesser than or equal to expected value
js
{ minLength: 8 }
Value must be greater than or equal to the expected value
js
{ minimum: 10 }
Value must be lesser than or equal to the expected value
js
{ maximum: 10 }
Value may not be empty
js
{ allowEmpty: false }
Value must be greater than expected value
js
{ exclusiveMinimum: 9 }
Value must be lesser than expected value
js
{ exclusiveMaximum: 11 }
Value must be divisible by expected value
js
{ divisibleBy: 5 }
{ divisibleBy: 0.5 }
Value must contain more then expected value number of items
js
{ minItems: 2 }
Value must contains less then expected value number of items
js
{ maxItems: 5 }
Value must hold a unique set of values
js
{ uniqueItems: true }
Value must be present in the array of expected value
js
{ enum: ['month', 'year'] }
Value must be a valid format
js
{ format: 'url' }
{ format: 'email' }
{ format: 'ip-address' }
{ format: 'ipv6' }
{ format: 'date-time' }
{ format: 'date' }
{ format: 'time' }
{ format: 'color' }
{ format: 'host-name' }
{ format: 'utc-millisec' }
{ format: 'regex' }
Value must conform to constraint denoted by expected value
js
{ conform: function (v) {
if (v%3==1) return true;
return false;
}
}
Value is valid only if the dependent value is valid
js
{
town: { required: true, dependencies: 'country' },
country: { maxLength: 3, required: true }
}
We also allow nested schema
js
{
properties: {
title: {
type: 'string',
maxLength: 140,
required: true
},
author: {
type: 'object',
required: true,
properties: {
name: {
type: 'string',
required: true
},
email: {
type: 'string',
format: 'email'
}
}
}
}
}
We also allow custom message for different constraints
js
{
type: 'string',
format: 'url'
messages: {
type: 'Not a string type',
format: 'Expected format is a url'
}
js
{
conform: function () { ... },
message: 'This can be used as a global message'
}
All tests are written with vows and should be run with npm:
bash
$ npm test