validex

The fastest and simple validator.

Install

npm install --save validex

use it with react react-validex

Usage

import validex from 'validex'

const validator = validex(data: Object, options: Object)

if(validator.validate()){

}

Options

Example

import validex from  'validex'

const data = {
    user_name: 'Jhon Doe',
    user_email: 'yourname@example.com',
    user_age: 20
}
const schema = {
    user_name: {
        nameAlias: "User Name",
        required: true,
        type: 'string',
        capitalize: true,
        notAllowedSpecialChars: true
    },
    user_email: {
        nameAlias: "Email",
        email: true,
        lowercase: true
    },
    user_age: {
        nameAlias: "Age",
        type: 'number',
        minNumberRange: 18,
        maxNumberRange: 30
    }
}
const validator =  validex(data, schema)

const isValidate = validator.validate()

if(isValidate){
    // .....
}

// Or You can the hasError function
if(!validator.hasError()){
    // .....
}

Schema format

In the schema property you can pass single option or you can pass an array. the array contained two indexes

• 1. Property type
• 1. Error message

Example

const schema = {
    user_name: {
        required: [true, new Error("$field must be required")], // or you can pass the arra
        type: ['string', new Error("$field must be type of string")],
        min: [10, new Error("$field minumum characters of $compare")], // $compare will be replaced with 10
        max: 20,
        notAllowedSpecialChars: true,
    }
}

Validator Methods

Validator Callback

It will call when validate and removeError function call

validator.callback = (type, validator) => {
    if(type === 'removeError'){

    }
}

Compare

Custom validation with compare. @return type boolean.

{
    compare: (value, options) => {
        if(typeof value !== 'string'){
            return new Error("$field must be string")
        }
    }
}

Individually Import

import {
    isType,
    isEmail,
    isEqual,
    isUrl,
    isHex,
    isUpperCase,
    isLowerCase,
    isCapitalize,
    minWords,
    maxWords,
    minNumberRange,
    maxNumberRange,
    notAllowedChars,
    notAllowedCharacters,
    notAllowedSpecialChars,
    notAllowedWords,
    notAllowedNumber,
    regex,
    strongPassword,
    mediumPassword,
    oneOf,
    oneOfType,
    exact,
    shape
} from 'validex'

// every function has two arguments
// first is value second is compare value

isType(value, 'numbe|object|array|string|bool')
isEmail(value)
isEqual(value, compareValue)
isUrl(value)
isUpperCase(value)
isLowerCase(value)
isCapitalize(value)
isHex(value)
minWords(value, length)
maxWords(value, length)
minNumberRange(value, length)
maxNumberRange(value, length)
notAllowedChars(value, characters)
notAllowedCharacters(value)
notAllowedNumber(value)
notAllowedSpecialChars(value)
notAllowedWords(value, 'Hello World, Programmer')
regex(value, expression),
strongPassword(value),
mediumPassword(value),
oneOf(value, ['public', 'private']),
oneOfType(value, ['string', 'number']),
shape({
    name: 'any',
    email: 'any@example.com'
}, {
    name: {
            /// validex props
    }
}),

exact({
    name: 'any',
    email: 'any@example.com'
}, {
    name: {
            /// validex props
    }
}),

Some utilities functions

import {isObject, isArray, isNumber, isInteger, isString, isBool} from 'validex'