t-val is an input validator, can be used with the input field and you can define set of rules to apply on input field.

Here's the Code Sandbox!

Installation

Installing the package.

$ npm install @taimoorimran/tval

Usage

// importing the package
    import tval from '@taimoorimran/tval';
// calling the function
    const config = { 
        ...
    }
    console.log(tval('value', config));

Configuration

Length

| Rule | Type | Value | Description | | ------ | ------ | ------ | ------ | | minLength | int | - | Length of string should be greater |

const config = {
    minLength: 5
}

| Rule | Type | Value | Description | | ------ | ------ | ------ | ------ | | maxLength | int | - | Length of string should be lesser |

const config = {
    maxLength: 5
}

| Rule | Type | Value | Description | | ------ | ------ | ------ | ------ | | length | int | - | Length of string should be equals to |

const config = {
    length: 5
}

Alphabets

| Rule | Type | Value | Description | | ------ | ------ | ------ | ------ | | allowUpper | bool | Default: False | Allow upper case characters in string - [A-Z] |

const config = {
    characters: {
        allowUpper: // true / false
    }
}

| Rule | Type | Value | Description | | ------ | ------ | ------ | ------ | | allowLower | bool | Default: False | Allow lower case characters in string - [a-z] |

const config = {
    characters: {
        allowLower: // true / false
    }
}

Numerals

| Rule | Type | Value | Description | | ------ | ------ | ------ | ------ | | allowNumeric | bool | Default: False | Allow numerals in string - [0-9] |

const config = {
    allowNumeric: // true / false
}

Space

| Rule | Type | Value | Description | | ------ | ------ | ------ | ------ | | dontAllowSpace | bool | Default: False | Allow spaces in string |

const config = {
    dontAllowSpace: // true / false
}

Special Characters

| Rule | Type | Value | Description | | ------ | ------ | ------ | ------ | | allowAll | bool | Default: False | Allow special characters => [!, @, #, $, %, ^, &, *] |

const config = {
    specialCharacters: {
        allowAll: // true / false
    }
}

| Rule | Type | Value | Description | | ------ | ------ | ------ | ------ | | onlyAllowThese | bool | Default: False | Add selective special characters |

const config = {
    specialCharacters: {
        onlyAllowThese: '&#_-'
    }
}

Overview

const config = {
    minLength: 1,
    maxLength: 5,
    //OR
    length: 10,
    allowNumeric: // true / false,
    characters: {
        allowUpper: // true / false,
        allowLower: // true / false
    },
    specialCharacters: {
        allowAll: // true / false,
        onlyAllowThese: '&#_-'
    }
}

License

t-val is MIT licensed.

Powered By