form-snap-js
v2.0.0
Published
A lightweight, chainable form validation library for JavaScript.
Maintainers
Readme
form-snap
A lightweight, chainable form validation library for JavaScript.
Installation
npm install form-snapFeatures
- Chainable API: Easy to read and write validation rules.
- Lightweight: Zero dependencies (except for development).
- Extensible: Easily add custom validation logic.
- Built-in Validators: Support for common validations like email, phone, password, and required fields.
Usage
const snap = require('form-snap');
const data = {
email: '[email protected]',
phone: '1234567890',
password: 'securePassword123'
};
const result = snap(data)
.field('email')
.required('Email is required')
.email('Please enter a valid email address')
.field('phone')
.required()
.phone('Invalid phone number')
.field('password')
.required()
.min(8, 'Password must be at least 8 characters')
.password('Password is too weak')
.validate();
if (result.valid) {
console.log('Form is valid!');
} else {
console.log('Validation errors:', result.errors);
}API Reference
snap(data)
Initializes the validation process with the provided data object.
.field(name)
Selects a field from the data object to apply validation rules to.
.required(message?)
Validates that the field is not empty.
.email(message?)
Validates that the field is a valid email address.
.phone(message?)
Validates that the field is a valid phone number.
.password(message?)
Validates that the field meets basic password strength requirements.
.min(length, message?)
Validates that the field has a minimum length.
.validate()
Executes all validation rules and returns an object:
valid: Boolean indicating if all rules passed.errors: An object containing error messages for each field that failed validation.
License
MIT © Nikhil Raj
