JSPM – validator@2.1.0

Package Exports

validator
validator/index.js
validator/lib/defaultError
validator/lib/validators

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (validator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

node-validator is a library of string validation, filtering and sanitization methods.

Server-side usage

To install node-validator, use npm

$ npm install validator

var check = require('validator').check,
    sanitize = require('validator').sanitize

//Validate
validator.check('test@email.com').len(6, 64).isEmail();        //Methods are chainable
validator.check('abc').isInt();                                //Throws 'Invalid integer'
validator.check('abc', 'Please enter a number').isInt();       //Throws 'Please enter a number'
validator.check('abcdefghijklmnopzrtsuvqxyz').is(/^[a-z]+$/);

//Set a message per validator
validator.check('foo', {
    isNumeric: 'This is not a number',
    contains: 'The value doesn\'t have a 0 in it'
}).isNumeric().contains('0');

//Referencing validator args from the message
validator.check('foo', 'The message needs to be between %1 and %2 characters long (you passed "%0")').len(2, 6);

//Sanitize / Filter
var int = validator.sanitize('0123').toInt();                  //123
var bool = validator.sanitize('true').toBoolean();             //true
var str = validator.sanitize(' \t\r hello \n').trim();         //'hello'
var str = validator.sanitize('aaaaaaaaab').ltrim('a');         //'b'
var str = validator.sanitize('&lt;a&gt;').entityDecode();      //'<a>'

Client-side usage

To use the library in the browser, include dist/validator.min.js

<script type="text/javascript" src="dist/validator.min.js"></script>
<script type="text/javascript">
    validator.check('foo@bar.com').isEmail();
</script>

Example

An important note

This library validates strings only. If you pass something that's not a string as input it will be coerced to a string using the following rules:

Is it an object with a toString property? Call input.toString()
Is it null, undefined, or NaN? Replace with an empty string
All other input? Coerce to a string using '' + input

List of validators

is()                            //Alias for regex()
not()                           //Alias for notRegex()
isEmail()
isUrl()                         //Accepts http, https, ftp
isIP()                          //Combines isIPv4 and isIPv6
isIPv4()
isIPv6()
isAlpha()
isAlphanumeric()
isNumeric()
isHexadecimal()
isHexColor()                    //Accepts valid hexcolors with or without # prefix
isInt()                         //isNumeric accepts zero padded numbers, e.g. '001', isInt doesn't
isLowercase()
isUppercase()
isDecimal()
isFloat()                       //Alias for isDecimal
notNull()                       //Check if length is 0
isNull()
notEmpty()                      //Not just whitespace (input.trim().length !== 0)
equals(equals)
contains(str)
notContains(str)
regex(pattern, modifiers)       //Usage: regex(/[a-z]/i) or regex('[a-z]','i')
notRegex(pattern, modifiers)
len(min, max)                   //max is optional
isUUID(version)                 //Version can be 3, 4 or 5 or empty, see http://en.wikipedia.org/wiki/Universally_unique_identifier
isUUIDv3()                      //Alias for isUUID(3)
isUUIDv4()                      //Alias for isUUID(4)
isUUIDv5()                      //Alias for isUUID(5)
isDate()                        //Uses Date.parse() - regex is probably a better choice
isAfter(date)                   //Argument is optional and defaults to today. Comparison is non-inclusive
isBefore(date)                  //Argument is optional and defaults to today. Comparison is non-inclusive
isIn(options)                   //Accepts an array or string
notIn(options)
max(val)
min(val)
isCreditCard()                  //Will work against Visa, MasterCard, American Express, Discover, Diners Club, and JCB card numbering formats

List of sanitizers / filters

trim(chars)                     //Trim optional `chars`, default is to trim whitespace (\r\n\t )
ltrim(chars)
rtrim(chars)
ifNull(replace)
toFloat()
toInt()
toBoolean()                     //True unless str = '0', 'false', or str.length == 0
toBooleanStrict()               //False unless str = '1' or 'true'
entityDecode()                  //Decode HTML entities
entityEncode()
escape()                        //Escape &, <, >, and "

Extending the library

When adding to the Validator prototype, use this.str to access the string and this.error(this.msg || default_msg) when the string is invalid

var Validator = require('validator').Validator;
Validator.prototype.contains = function (seed) {
    if (this.str.indexOf(seed) === -1) {
        this.error(this.msg || this.str + ' does not contain ' + seed);
    }
    return this; //(for chaining)
}

When adding to the Filter (sanitize) prototype, use this.str to access the string and this.modify(new_str) to update it

var Filter = require('validator').Filter;
Filter.prototype.removeNumbers = function() {
    this.modify(this.str.replace(/[0-9]+/g, ''));
    return this.str;
}

Error handling

By default, the validation methods throw an exception when a check fails

try {
    validator.check('abc').notNull().isInt()
} catch (err) {
    console.log(err.message); //Invalid integer
}

To set a custom error message, set the second param of check()

try {
    validator.check('abc', 'Please enter a valid integer').notNull().isInt()
} catch (err) {
    console.log(err.message); //Please enter a valid integer
}

To attach a custom error handler, set the error method of the validator instance

var Validator = require('validator').Validator;

var validator = new Validator();
validator.error = function(msg) {
    console.log('Fail');
}
validator.check('abc').isInt(); //'Fail'

You might want to collect errors instead of throwing each time

Validator.prototype.error = function (msg) {
    this.errors = this.errors || [];
    this.errors.push(msg);
    return this;
}

var validator = new Validator();

validator.check('abc').isEmail();
validator.check('hello').len(10,30);

console.log(validator.errors); // ['Invalid email', 'String is too small']

Contributors

zero21xxx - Added per check messages
PING - Fixed entity encoding
Dan VerWeire - Modified the behaviour of the error handler
ctavan - Added isArray (since removed) and isUUID
foxbunny - Added min(), max(), isAfter(), isBefore(), and improved isDate()
oris - Added in()
mren - Decoupled rules
Thorsten Basse - Cleanup and refinement of existing validators

License (MIT)

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.