Module Validator

Usage

With throw try catch

const Validator = require('validator-chain');

function some(p1, p2, p3, error) {
	Validator(p1, 'p1').must.exist().must.be.number().and.not.equal(0).is.lowerThan(256).try();

	Validator(p2, 'p2').exist().string().not.length(0).match(/^[A-Z]{4}$/).try();

	Validator(p3, 'p3').array().not.have.length(6).each((vChild) => {
		vChild.object().keys('address', 'zipcode', 'email', 'age', (vAddress, vZipcode, vEmail, vAge) => {
			vAddress.string(); // Don't call try/resolve on nested chain
			vZipcode.string().match(/^[0-9]{4}$/);
			vEmail.string().match(...);
			vAge.number();
		}); // Don't call try/resolve on nested chain
	}).try();

	// And so on ...
}

With resolve then catch

const Validator = require('validator-chain');

function idChain(vId) {
	vId.integer().not.equal(0)
}

function some(customer) {
	return Validator(customer, 'customer').or(
		idChain,
		vCustomer => vCustomer.object().keys(
			{ key: 'id', chain: idChain },
			{ key: 'name', chain: (vName => vName.string().length(vLength => vlength.greaterThan(3).not.greaterThan(20)).match(/^[\w-']$/)) },
			{ key: 'email', chain: vEmail => vEmail.string().match(/^[\w]+@[\w]+\.[\w]{2,}$/) },
			{ key: 'age', optional: true, chain: vAge => vAge.integer().greaterThan(0).not.greaterThan(130) },
		),
	).resolve().then(() => {

	}).catch((error) => {

	});
}

Express/Koa control body

app.put('/api/catalog/mine/products/:id',
	Validator.mw.express.body({ key: 'label', chain: vLabel => vLabel.string() }),
	Validator.mw.express.body({ key: 'enabled', optional: true, chain: vEnabled => vEnabled.boolean() }),
	Validator.mw.express.body({ key: 'quantity', optional: true, chain: vQuantity => vQuantity.or(vQ => vQ.equal(null), vQ => vQ.integer()) }),
	Validator.mw.express.body({ key: 'price', optional: true, chain: vPrice => vPrice.integer().greaterThan(0) }),
	Validator.mw.express.body({ key: 'reference', optional: true, chain: v => v.or(vRef => vRef.equal(null), vRef => vRef.string()) }),
	(req, res) => {
		// TODO
	});

References

callbacks
instanceOf
- Parameters
isInstance
- Parameters
mustBeInstance
- Parameters
Validator
- isValid
- error
- invalidate
  - Parameters
- invalidateOn
  - Parameters
- setModifier
  - Parameters
- resetModifier
- not
- apply
  - Parameters
- exist
- type
  - Parameters
- instance
  - Parameters
- equal
  - Parameters
- among
  - Parameters
- greaterThan
  - Parameters
- lowerThan
  - Parameters
- greaterOrEqualThan
  - Parameters
- lowerOrEqualThan
  - Parameters
- match
  - Parameters
- startsWith
  - Parameters
- endsWith
  - Parameters
- hexadecimal
- base64
- url
- boolean
- number
- integer
- string
- object
- array
- function
- length
  - Parameters
- each
  - Parameters
- keys
  - Parameters
- or
  - Parameters
- try
- resolve

callbacks

ErrorBuilder

Function building error.

Returns Error Responsible error.

Checker

Function checking if "value" is valid or not

Parameters

value any Value to check.

Returns Boolean true if valid, false otherwise.

ChainApplier

Function appling chain validation on parameter.

Parameters

Validator Validator to apply chain on.

instanceOf

Access 'constructor.name'.
if undefined or null, return 'undefined'

Parameters

data any argument

Returns String Type name, one of 'undefined', 'Boolean', 'Number', 'String', 'Array', 'Object', 'Function', '${ClassName}'

isInstance

See: instanceOf

Compare if item is an element of expectedType. Allow inheritance.

Parameters

item any Element for which type is checked.
expectedInstance (String | Function) String representation or constructor of type to looking for

Returns Boolean true if item or its ancestry is type of expectedType.

mustBeInstance

Compare if item is an element of expectedType. Allow inheritance.
Throw error if failed.

Parameters

item any Element for which type is checked.
expectedInstance (String | Function) String representation or constructor of type to looking for
name String Name of item for error building

Returns undefined

Validator

isValid

Return if chain is valid or invalidated

Returns Boolean true if valid, false otherwise

error

returns the error responsible for the invalidation

Returns Errors Responsible error or null.