Freeval

Freeval (for free validator) provides a flexible validation mechanism for objects based on predefined rules. It's a typescript implementation of freeval, a struct validation crate in Rust.

• See Live Demo
• See Video Demo

Installation

To install the freeval, you can use npm:

npm install freeval

or yarn

yarn add freeval

Usage

Here's how you can use the freeval in your TypeScript projects:

import { Validator, ValidatorRules } from 'freeval';

// Not necessary but you can define an interface for your data
interface UserData {
    username: string;
    email: string;
    password: string;
    confirmPassword: string
}

// Define your data object and validation rules
const data: UserData = {
    username: 'prodbyola',
    email: '[email protected]',
    password: 'securePassword123',
    confirmPassword: ''
};

const rules: ValidatorRules<UserData /* or typeof `data` */> = {
    username: [
        { condition: 'required', error: 'Username is required' },
        // minimum of 8 characters length
        { 
            condition: 'min_len', 
            error: 'Username must be 8 characters minimum', 
            size: 8 
        }, 
    ],
    email: [
        // Setting an error message is OPTIONAL.
        { condition: 'required' },
        { condition: 'email', error: 'Invalid email format' }
    ],
    password: [
        { condition: 'required', error: 'Password is required' },
        { condition: 'password', error: 'Weak password' }
    ]
    confirmPassword: [
        // You can also define your custom boolean condition
        { 
            condition: data.password === data.confirmPassword,
            error: 'Please confirm your password.'
        }
    ]
};

// Create a new Validator instance
const validator = new Validator(data, rules);

// Validate the data
const isValid = validator.validate();

if (!isValid) {
    console.log('Validation failed. Errors:');
    console.log(validator.errors);
} else {
    console.log('Validation successful.');
}

API

Validator<T>

The Validator<T> class provides methods for data validation.

constructor(data: T, rules?: ValidatorRules<T>)

• data: The object to be validated.
• rules: Optional. The validation rules for the object properties.

valid: boolean

Validates the object against the specified rules. Returns true if the object passes validation; otherwise, returns false.

Make sure you call either validate or validateField function before accessing this propery correctly:

    const validator = new Validator(data, rules)
    const isValid = validator.validate()
    validator.valid

invalid: boolean

Returns a negated value of valid.

Make sure you call either validate or validateField function before accessing this propery correctly:

    const validator = new Validator(data, rules)
    const isValid = validator.validate()
    validator.invalid

validate(): boolean

Validates all properties or fields in data based on speified rules.

setRules(rules: ValidatorRules<T>): void

Sets the validation rules for the object properties.

getErrors(field: keyof T): string[] | undefined

Gets the validation errors for a specific data field or property.

clearFieldErrors(field: keyof T): void

Clears the validation errors for a specific data field or property.

clearAllErrors(): void

Clears all validation errors.

getFieldRules(field: keyof T): ValidatorRule[] | undefined

Retrieves validation rules defined for a data field. Returns undefined if no rule is declared for field.

removeFieldRules(field: keyof T): void

Remove all rules added for a field or property.

removeFieldRule(field: keyof T, rule: ValidatorRule): void

Remove a specific rule added to a field or property.

Contributing

Contributions to the freeval package are welcome! Feel free to submit bug reports, feature requests, or pull requests through the GitHub repository.

License

This project is licensed under the GPL License - see the LICENSE file for details.