teseract-validatorjs
v1.0.2
Published
JavaScript library to validate the values of the fields of forms or variables in general
Downloads
4
Maintainers
Readme
JavaScript library to validate the values of the fields of forms or variables in general
Installation
npm i teseract-validatorjsAvailable languages
- English ('en') Default
- Spanish ('es')
- Italian ('it')
- Portuguese ('pt')
- French ('fr')
- Deutsch ('de')
- Japanese ('ja')
- Chinese ('zh')
- Russian ('ru')
Usage example
import Validator from 'teseract-validatorjs'
import it from 'teseract-validatorjs/lang/it'
import custom from '../languages/validator'
const validator = new Validator()
// const validator = new Validator('es')
// const validator = new Validator(it)
// const validator = new Validator(custom)
const number = 133
const text = 'John Doe'
const inputLastName = document.querySelector('#last-name')
const inputEmail = document.querySelector('#email')
validator.add(number, 'Number const').required().isNumber().min(150).maxLength(4)
validator.add(text, 'Text const').isString().minLength(3)
validator.add(inputLastName.value, 'Last name', inputLastName.id).required('The last name is required, please check it.').isString().minLength(inputLastName.minLength)
validator.add(inputEmail.value, 'Email', inputEmail.id).required().isString().isEmail().addListener()
if(validator.hasErrors()){
console.log(validator.getFirstError())
// or
console.log(validator.getErrorsMessages())
// or
console.log(validator.getErrorsDetail())
// or
document.querySelector('#div-errors').appendChild(validator.getErrorsList())
}Methods
Note: The
personalized_messageparameter is to show a custom error message for each error.
| Method | Description |
|-|-|
| add(value: string/number/null, field_name: string, element_id: string/number/null) | Add the value to the validations, the name of the field where the error will be displayed and the element_id to display the error below that element |
| required(personalized_message: string/null) | Check if the field value is empty or null |
| isNumber(personalized_message: string/null) | Check if the field value is a number or not |
| isString(personalized_message: string/null) | Check if the field value is a text or not |
| isEmail(personalized_message: string/null) | Check if the field value has email format |
| isTrue(personalized_message: string/null) | Check if the field value is true or not |
| isFalse(personalized_message: string/null) | Check if the field value is false or not |
| isNull(personalized_message: string/null) | Check if the field value is null or not |
| isEmpty(personalized_message: string/null) | Check if the field value is empty or not |
| max(max: number, personalized_message: string/null) | Check if the field value is less than or equal to the max value |
| min(min: number, personalized_message: string/null) | Check if the field value is greater than or equal to the min value |
| maxLength(max: number, personalized_message: string/null) | Check if the length of the field value is less than or equal to the max value |
| minLength(min: number, personalized_message: string/null) | Check if the length of the field value is greater than or equal to the min. |
| maxYear(max: number, personalized_message: string/null) | Check if the year of a date is greater than the max value |
| minYear(max: number, personalized_message: string/null) | Check if the year of a date is less than the min value |
| notEqual(value: string/number/null, second_field_name: string, personalized_message: string/null) | Check if the field value is not equal to the first value entered. |
| equal(value: string/number/null, second_field_name: string, personalized_message: string/null) | Check if the field value is equal to the first value entered. |
| customErrorRegex(errorName: string, regex: RegExp, errorMessage: string) | This function allows you to validate the value entered in the .add with a regex |
| addListener(formatValue: function) | Listener for the value (to use it you must put the element id in the .add function ) and this end the chain functions |
| hasErrors() | Check if any field has an error. Return true o false |
| getFirstError() | Return the first error message |
| getErrorsMessages() | Returns errors messages in an array |
| getErrorsDetail() | Returns errors in this format [... {field_name: string, error: string, message: string}] |
| getErrorsList(ulAttributes: Object/null, liAttributes: Object/null | Returns errors in an HTML listing. You can indicate the attributes of the elements UL and LI through an object: {class, id, etc} |
License
This library is licensed under the MIT License.
