Package Exports
- @saimulhasnain-dev/input-validator
- @saimulhasnain-dev/input-validator/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@saimulhasnain-dev/input-validator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Input validator
Human-friendly and powerful data validator library for JavaScript
Prerequisites
This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.
$ npm -v && node -v
6.4.1
v8.16.0
Getting Started
These instructions will help you to install this package in your project to perform data validation.
Installation
BEFORE YOU INSTALL: please read the prerequisites
Start with installation of package in your project:
$ cd PROJECT
$ npm i @saimulhasnain-dev/input-validator
After successful installation of package you need to import package in your file: To import complete package in once
$ import validator from '@saimulhasnain-dev/input-validator';
Or if you prefer using any particular function then:
$ import { isAlphabet } from '@saimulhasnain-dev/input-validator';
Examples
import validator from '@saimulhasnain-dev/input-validator';
let res = validator.isAlphabet('abc');//to verify string contains alphabet
console.log(res); // it will print `true` as it contains alphabet
validator.isStrongPassword('Qwert@!2313');//to check password strength
Accessing only required function
import { isValidEmail } from '@saimulhasnain-dev/input-validator';
isValidEmail('abc@gmail.com');//to test email is valid or not
import { getValueFromObject, isKeyExistsNested } from '@saimulhasnain-dev/input-validator';
const user = {
name: "abc",
email: "xyz@email.com",
address: {
state: "New york",
country: "USA",
phones: {
primary: "+1234567890",
secondary: "+0987654321"
}
}
}
getValueFromObject(user, ["address", "state"]);//to get value of `state` key inside `address` object
getValueFromObject(user, ["address", "phones","primary"])////to get value of `primary` key inside `phone` object inside `address`
isKeyExistsNested(user, "address", "phones","primary");// to check if key `primary` exists in this object or not
Available methods
- isEmptyArray: To check if array is empty or not
- isString: To check if value is string or not
- isNumeric: To check string is numeric type
- isValidEmail: To check email is valid or not
- isAlphabet: To check if string contain alphabet only
- isAlphaNumericOnly: To check if string contains alphabet and numeric as well
- isSpecialCharAlphaNumeric: To check if string contains alphabet with combination of number and special characters
- isUndefined: To check if variable is undefined
- isNull: To check if variable is null
- isBoolean: To check if variable boolean
- isArray: To check if variable is an array
- sanitizeString: To get sanitized version of value
- toInt: To parse in integer format
- toFloat: To parse in floating point format
- toDate: To parse in date type
- isURL: To check if a URL is valid or not
- isValidNumber: To check valid numnber
- isValidLatLong: To check valid latitude and longitude points
- isStrongPassword: To check string password complexity
- isMediumPassword: To check medium password complexity
- isDate: To check if a value is date
- isObject: To check if a value is object
- isKeyExists: To check if a particular key is exists in an object or not(not in nested object)
- isKeyExistsNested: To check if a particular key is exists in an object or not(in nested object)
- getValueFromObject: To get value of a key from a nested object
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Add your changes:
git add .
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request π
Credits
All credit goes to meπ
Built With
- Love
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Saimul Hasnain - Initial work - Saimul Hasnain