aright
Small and really fast js objects and types validation (browser or server side).
Allow to describe validation rules with compact chained API.
Easy i18n.
Really fast because it doesn't need schema parsing and interpretation. Rules holds directly an array of simple functions that do the job as fast as possible.
Pure vanilla js, no dependencies.
Small size (4.0 Ko minified, 1.4 Ko min/gzip).
Install
npm i aright# or bower i aright# or git clone https://github.com/nomocas/aright.git
Examples
var v = arightv; var rule = object'child' ; rule;// => return true
arightrulesemail; // return error report// equivalent to :; // return error report
; // return true; // return error report
Full API
is* Family
.isString(), isNumber(), .isBool(), .isObject(), .isArray(), .isFunction(), .isNull()
; //return true
.type('string', 'object', ...)
Sugar for .or(v().isString(), v().isObject(), ...)
.instanceOf(Class)
var rule = result = rule; // return true
properties validation
.bool(propName, rule) .number(propName, rule) .string(propName, rule) .func(propName, rule) .null(propName, rule) .object(propName, rule) .array(propName, rule)
; //return true
value constraints
.required(false), .minLength(5), .maxLength(3), .minimum(7), .maximum(9), .enumerable(['foo', 12]), .equal('my value')
Any value is required by default. Only undefined will be seen as missing.
; // return true ; // return error report //...
value format
Validate value against regExp
; // return true
To define custom format :
arightformatsmyFormat = /abc/gi;; // return true
As predefined format there is only email for the moment...
; // return true
array and items
Both work together :
var o = collection:'foo' 'bar' 'zoo'; ; // return true
.not and .or
var rule = result = rule && rule; // return true
var rule = result = rule && rule; // return true
validation
Any value could be validated by calling .validate( valueToTest ) on any aright rule.
It returns true if rule is satisfied or an error report as follow if something fails :
var rule = object'child' ; var result = rule; /* result == { "valid": false, "map": { "email": { "value": "aaa@bbb", "errors": [ "format failed" ] }, "index": { "value": 1, "errors": [ "equality failed (should be : 24)" ] }, "flag": { "value": "hello", "errors": [ "should be a boolean" ] }, "collection.0": { "value": 1, "errors": [ "should be a string" ] }, "child.title": { "value": null, "errors": [ "missing property" ] }, "test": { "value": 3, "errors": [ "should be a boolean" ] } }, "value": { "email": "aaa@bbb", "index": 1, "flag": "hello", "collection": [ 1 ], "child": null, "test": 3 }}*/
custom rule
To define custom rules :
arightrulesmyRule = ;; // return true
custom 'this' handler
// handler that act on 'this' (as is* family)arightValidatorprototype{ return this;}; ;
custom property handler
// handler that act on choosen propertyarightValidatorprototype{ return this;}; ;
i18n
Take a look to aright/i18n/fr.js
to have an idea on how customise
arighti18ndatafr = ;arighti18ncurrentLanguage = 'fr';// aright errors messages will now be in french
Tests
Under nodejs
You need to have mocha installed globally before launching test.
> npm install -g mocha
Do not forget to install dev-dependencies. i.e. : from 'aright' folder, type :
> npm install
then, always in 'aright' folder simply enter :
> mocha
Licence
The MIT License
Copyright (c) 2015 Gilles Coomans gilles.coomans@gmail.com
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.