The Vladiator


Javascript validation and assertion library. Suggestions are welcome.

Includes Typescript definitions.

Installation

You can grab the latest version via NPM or Bower.

``bash
npm install --save the-vladiator
bower install --save the-vladiator
`

Then either use require through NodeJS.

`javascript
var validate = require('the-vladiator');
validate('email@email.com')
`

Or add as a script to your HTML.

`html

`
`javascript
validate('email@email.com')
`

Getting Started

Below are some basic examples of usage.

`javascript
var validate = require('the-vladiator');

//E-mail address
validate('email@email.com').isRequired().isString().isEmail().didPass(); //returns true if passed validation

//Name
validate('John').isRequired().isString().notEmpty().didFail(); //returns true if failed validation

//Positive number
validate(5).isRequired().isNumber().isPositive().throws('Number must be positive'); //throws if failed validation
`

$3

You can test whether your input is a certain type.

`javascript
.isBool()
.notBool()

.isTrue()
.notTrue()

.isFalse()
.notFalse()

.isNumber()
.notNumber()

.isString()
.notString()

.isDate()
.notDate()

.isArray()
.notArray()

.isObject()
.notObject()

//Checks for an array or object
.isParent()
.notParent()
`

$3

`javascript
//Checks for equality using ===

.isEqual(comparison)

.notEqual(comparison)

//Check contents using indexOf

.contains(comparison)

.notContains(comparison)
`

$3

`javascript
.isPositive()
.isNegative()

.higherThan(amount)
.lowerThan(amount)
`

$3

`javascript
.isEmpty()
.notEmpty()

.hasLength(length)

.longerThan(length)
.shorterThan(length)
`

$3

`javascript
//Ensures that value is defined, not null and not NaN
.isRequired()

//Skips remaining checks if value is undefined, null or NaN
.isOptional()

//Ensures the value is defined
.valueRequired()

//Skips remaining checks if value is undefined
.valueOptional()
`

$3

`javascript
.missingKey(key)
.hasKey(key)

.missingValue(value)
.hasValue(value)

.missingKeyValue(key, value)
.hasKeyValue(key, value)
`

$3

`javascript
//The value can be replaced with a nested object one or more levels deeper
.open('key')
.open('firstKey.secondKey')

//Iterates checking inside arrays or objects, all subsequent checks will be performed on each
.extract()
.extract('key')
.extract('firstKey.secondKey')

//Iterates checking through all nested levels inside arrays or objects
.recursive()
`

$3

`javascript
//Validates whether input is pie
.is(function(value){
return value === Math.PI;
});
`

$3

`javascript
.isEmail(email)
.notEmail(email)

//Checks for MongoDB ObjectIds
.isMongoId()
.notMongoId()

//Checks whether value is an Enum.
//Arguments are a mongoose model or schema and property name string
.isMongoEnum(type, field)
.notMongoEnum(type, field)

//Checks whether value confirms to semver
.isSemver(version)
.notSemver(version)
`

$3

`javascript
//Replaces the currently checking value
.and(newValue)

//Inverts the following checks result
.not()

//Changes values case
.upperCase()
.lowerCase()
`

$3

We can compose some pretty lengthy validation rules as demonstrated below though it's recommended to split them into smaller more readable chunks.

#### Example One

`javascript
validate('myPassword').isString().longerThan(6).shorterThan(20).notContains('password').notEmail().throw('Enter a strong password')
`

#### Example Two

`javascript
var data = {
usernames: [
'User1',
'User2',
'User3',
'User4',
'User5'
],
emails: [
'admin1@vmlweb.co.uk',
'admin2@vmlweb.co.uk',
'admin3@vmlweb.co.uk',
'admin4@vmlweb.co.uk',
'admin5@vmlweb.co.uk'
]
};

validate(data).hasKey('usernames').hasKey('emails')
.extract('usernames').isString().notEmpty()
.and(data)
.extract('emails').isString().isEmail()
.throw('failed');
`

#### Example Three

`javascript
var database = {
users: {
metadata: {},
ids: [
'507f1f77bcf86cd799439011',
'507f1f77bcf86cd799439012',
'507f1f77bcf86cd799439013',
'507f1f77bcf86cd799439014',
'507f1f77bcf86cd799439015',
'507f1f77bcf86cd799439016',
'507f1f77bcf86cd799439017',
'507f1f77bcf86cd799439018',
'507f1f77bcf86cd799439019',
'507f1f77bcf86cd799439020',
'507f1f77bcf86cd799439021'
]
}
};

validate(database).extract('users.ids').isMongoId().is(function(value){

//Check whether exists in database
var exists = true;
return exists;

}).throw('failed');
``