light-validate-js v0.0.2

Light Validate JS

This package provides light weight flexible JS validate helpers, supports async and group validation.

My goal for this repo is to avoid the binding of error messages & DOM elements and validations which would be more flexible to be used everywhere.

Installation

Light Validate JS module is available on the npm registry and can be installed using the

npm install light-validate-js

Example usage

• RSVP setting:

Validator.validate.Promise = Promise;

• To validate a single field

/**
 * 1st parameter is the value you want to validate,
 * 2nd parameter is the validator, which will carry
 * out the validations one by one basing on the
 * given order.
 *
 * It stops once one of the validations fail
 */
var validatePromise = Validator.validate.validate(fieldValue, [

    // You can pass an array [validateFunc, ...parameters]
    [function(value, param1, param2) {
        // validate pass
        return true;
    }, param1, param2],

    // Or pass an object like following:
    {
        validator: function(value, param1) {
            // validate fail
            return false;
        },
        parameters: [param1],
        errorMessage: 'This is error message!'
    },

    // validate fail and return error message directly
    [function() {
        return 'This is error message!';
    }],
    {
        validator: function(param1) {
            return 'This is error message!';
        },
        parameters: [param1]
    },

    // Async validate success
    [function() {
        return Promise.resolve(true);
    }],
    // Async validate fail
    [function() {
        return Promise.resolve(false);
    }],
    [function() {
        return Promise.resolve('This is error message!');
    }],
    [function() {
        return Promise.reject('This is error message!');
    }]
]);

validatePromise.then(function() {
    alert('Validate pass!');
}).catch(function(error) {
    alert(error.errorMessage);
});

• To validate multiple fields

var validatePromise = Validator.validate.groupValidate({
    username: {
        value: 'jennie',
        validators: [
            [Validator.validator.Length, {min: 3, max: 10}]
        ]
    },
    email: {
        value: 'jennie.ji@hotmail.com',
        validators: [
            {
                validator: Validator.validator.Email,
                parameters: null,
                errorMessage: 'This is error message!'
            }
        ]
    }
}, isExitOnceError);

validatePromise.then(function() {
    alert('Validate pass!');
}).catch(function(errors) {
    alert(errors.map(function(err) {
        return err.name + ': ' + err.errorMessage;
    }).join('\n'));
});

Development Setup

• download and install NodeJS
• run npm install
• run the tests using npm test
• regenerate document: npm run docs

Development

Install nodeJs and run $: npm install.
Build to /disc: $: npm run build
Run unit testing: $: npm test
Regenerate document: $: npm run docs

API

Modules

Functions

Typedefs

validate

• validate
  • .validate(value, validators) ⇒ ValidatePromise
  • .groupValidate(group, [exitOnceError]) ⇒ ValidatePromise

validate.validate(value, validators) ⇒ ValidatePromise

Kind: static method of validate
Access: protected

Example

validate('jennie.ji@shopeemobile.com', [
	[length, {min: 0}],
	[email]
]);

validate.groupValidate(group, exitOnceError) ⇒ ValidatePromise

Kind: static method of validate
Access: protected

Example

groupValidate({
	name: {
		value: 'Jennie',
		validators: [
			[length, {min: 3, max: 50}]
		]
	},
	email: {
		value: 'jennie.ji@shopeemobile.com',
		validators: [
			[length, {min: 0}],
			[email]
		]
	}
});

validator

validate(value, validators) ⇒ ValidatePromise

Kind: global function
Access: protected

Example

validate('jennie.ji@shopeemobile.com', [
	[length, {min: 0}],
	[email]
]);

groupValidate(group, exitOnceError) ⇒ ValidatePromise

Kind: global function
Access: protected

Example

groupValidate({
	name: {
		value: 'Jennie',
		validators: [
			[length, {min: 3, max: 50}]
		]
	},
	email: {
		value: 'jennie.ji@shopeemobile.com',
		validators: [
			[length, {min: 0}],
			[email]
		]
	}
});

Email(value) ⇒ boolean

Kind: global function

Length(value, hash) ⇒ boolean

Kind: global function

Properties

NumberRange(value, hash) ⇒ boolean

Kind: global function

Properties

Number(value) ⇒ boolean

Kind: global function

Regular(value, hash) ⇒ boolean

Kind: global function

Properties

Validator : object | Array.<(function()|object)>

Validator

Kind: global typedef
Properties

ValidateError : object

ValidateError

Kind: global typedef
Properties

ValidatePromise : Promise

ValidatePromise

Kind: global typedef
Properties