###See the list of default validators
Create composable, re-usable validators with in-depth, client-friendly error messages.
#Installation
###Server-side
npm install prove-itvar prove = require('prove-it');###Client-side
<script type="text/javascript" src="prove-it.min.js"></script>window.prove; // Global prove.Or install with bower
bower install prove-it
define(['prove-it'], function (prove) {...});#Goals
- Chainable validations that could be composed and extended easily.
- Validate all of the fields of an object (even deep ones).
- Validate entire arrays and collections.
- An error message structure that is both friendly and usable; for clients and developers.
#Example
var doc = {
name: {
first: 'hello',
last: 'world'
},
dates: {
start: new Date(),
end: new Date()
},
phones: [
{
number: '5555555'
},
{
number: 1,
label: 'home',
invalidField: 'hacks'
}
]
};
var contactValidation = {
name: prove({ // Prove nested objects.
first: prove('First Name').isString().isLength(4),
last: prove('Last Name').isString().isLength(6)
}),
dates: prove('Date').run(function (date) {
return prove({
start: prove('Start date').isDate().isBefore(date.end),
end: prove('End date').isDate().isAfter(date.start)
});
}),
phones: prove('Phones').every( // Prove an entire array.
prove({
number: prove('Phone Number').isString().isPhoneNumber(),
label: prove('Phone Label').isString()
})
)
};
var passed = prove(contactValidation, /**Merge other object validations here!*/).test(doc);
if (true === passed) {
// Success!
} else {
console.log(passed);
// Would output all of the errors!
/**
{
"message": "Validation failed",
"name": "ValidationError",
"errors": {
"name.last": {
"message": [
"Last Name should be more than 6 characters long"
],
"value": "world"
},
"dates.start": {
"message": [
"Start date should be before Sat, 06 Dec 2014 17:04:51 GMT"
],
"value": "Sat, 06 Dec 2014 17:04:51 GMT"
},
"dates.end": {
"message": [
"End date should be after Sat, 06 Dec 2014 17:04:51 GMT"
],
"value": "Sat, 06 Dec 2014 17:04:51 GMT"
},
"phones.0.label": {
"message": [
"Phone Label is a required field"
]
},
"phones.1.number": {
"message": [
"Phone Number should be a string",
"Phone Number should be a phone number"
],
"value": 1
},
"phones.1.invalidField": {
"message": [
"invalidField is not an allowed field"
],
"value": "hacks"
}
}
}
*/##Creating A Validator
- Create an object and give it a key with the validator name.
{
myValidator: ...
}- The validator must point to a function that can take in some optional initial arguments.
myValidator: function(args) {...}- The function must also return an object with keys: { validator, msg }
myValidator: function(args) {
return {
validator: function(val) {
//Do the true/false validation here (has access to args).
},
msg: '{PATH} should work with myValidator:' + args //The error message for the validator
//{VALUE} = The value passed into the validator function.
//{PATH} = Either the schema path or the path passed into the prove(PATH) chain.
}
}##Extending The Validator
Prove-It has an attached 'extend' which can take in an object containing validators.
prove.extend({/**Validators Here*/})Eg.
prove.extend({
isEqualTo: function(compare) {
return {
validator: function(val){
return val === compare;
},
msg: '{PATH} should equal ' + compare + ' but got {VALUE}'
};
}
})##Running Field Validators
- Invoke the Prove-It function with a string or null to begin chaining, this string will replace {PATH} in the error messages.
prove(/**Optional {PATH} name*/)- Call any number of validators, and finally call 'test' with a value.
prove('Email Field').isString().isDomain().test('facebook.com') // returns true
prove('Email Field').isString().isDomain().test('facebook') // returns array of error messages based on tests.##Object Validator
#####(Note: Passing in multiple objects will merge the objects)
- Invoke Prove-It with an object(s) containing tests to have it validate the fields of a given object.
var myObjectValidator = prove({
field1: prove('My first field').isString(),
field2: prove({
subfield: prove('Subfield of field2').isString()
})
}); // Creates a test that validates that an object has only field1 and it is a string.- Call test the same as a regular field validator to evaluate all the fields
myObjectValidator.test({
field1: 1,
field2: {
subfield: 2
}
});Returns an object such as:
{ message: 'Validation failed',
name: 'ValidationError',
errors:
{ 'field1': { message: ['My first field should have been a string'], value: 1 },
{ 'field2.subfield': { message: ['Subfield of field2 should have been a string'], value: 2 } }##Array Validator
- Invoke Prove-It and chain with #every, passing every the prove validators to run on each item in the array.
var mySimpleArrayValidator = prove('My Array').every(
prove('Array Item').isString()
); // Would run isString on all of the array elements.
var myCollectionValidator = prove().every(
prove({
field1: prove('My field').isString()
})
); // Validates all items in the array against the given prove object validator.##Function Validator
-
Invoke Prove-It and chain with #run.
-
All functions passed will be passed the current sub-document and can return a test or undefined (results in true).
Note: If the path of the returned validator is '{PATH}' its errors will be interpolated.
Eg.
var myFunctionValidator = prove('My field').run(function (val) {
// ... Do stuff with val.
if (val === something) {
return prove('This value').isString(); // Path is overwritten with 'This value'.
} else {
return prove('{PATH}').isNumeric(); // Path is 'My Field'.
}
});###Contributions
- Use .jshintrc file as the coding standards.
- Use grunt to run tests.
Please feel free to recommend more default validators and/or submit a PR!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent