QuVA - Simplified Object Validation

QuVA is a lightweight TypeScript library designed to simplify and streamline the process of data validation in TypeScript projects. With QuVA, you can easily define and apply validation rules to your data, ensuring its integrity and validity.

Get Started

To start using QuVA in your TypeScript projects, simply install it via npm:

npm install quva

Then, import the necessary functions and start validating your data effortlessly!

Key Features

1. Simple and Lightweight: QuVA is designed to be simple and lightweight, providing essential validation functionalities without unnecessary complexity.

2. Type-Safe: Built with TypeScript, QuVA ensures type safety throughout the validation process, reducing the risk of runtime errors.

3. Flexible Validation Rules: Define custom validation rules using simple functions, allowing you to tailor the validation process to your specific requirements.

4. Validation Composition: Easily compose multiple validation rules for complex validation scenarios, ensuring comprehensive data validation.

5. Error Handling: QuVA provides detailed error handling, allowing you to identify and handle validation errors efficiently.

6. Object Validation: Validate entire objects with ease, making it suitable for various use cases.

Usage Example

// Define interface (optionals)
interface User {
  username: string;
  password: string;
  email: string;
}

// Define object value
const user: User = {
  username: "myUsername",
  password: "Secret123",
  email: "[email protected]",
};

// Create validation rules for each property of the object
const validator = createValidator<User>(user, {
  username: [new IsRequired(), new MinLength(6), new MaxLength(18)],
  password: [new IsRequired(), new MinLength(6), new MaxLength(18)],
  email: [new IsRequired(), new EmailOnly()],
});

console.log(validator.check); // true if valid, false otherwise
console.log(validator.errors); // if check is false, errors message return here

API Documentation

createValidator(data, credentials)

The createValidator function is a utility designed to facilitate the creation of validation rules for objects based on a specified data structure.

Parameters

• data: The object to be validated. Its structure must match the type T.
• credentials: An object specifying validation rules for each property of the object to be validated. It uses TypeScript's mapped types to ensure that each property of T is associated with an array of validation functions.

Returns

• check: A boolean value indicating whether the object passed all validation rules (true if valid, false otherwise).
• errors: A function returning detailed error messages for each property that failed validation.

Built-in Validators

QuVA provides the following built-in validators:

• IsRequired(errorMessage): Validates whether the string is a non-empty value.
• EmailOnly(errorMessage): Validates whether the string is in Email Format.
• MaxLength(max, errorMessage): Validates the maximum length of the value.
• MinLength(min, errorMessage): Validates the minimum length of the value.
• RangeNumeric(min, max, errorMessage): Validates the range of numeric values.
• Include(array, errorMessage): Validates that the value is within a specified set.

Note: All errorMessage parameters are optional for customizing your error message responses. You can modify them as needed.

Custom Validators

You can create custom validation rules by implementing the QuVA abstract class.

Contributing

QuVA is an open-source project, and contributions are welcome! If you encounter any issues, have feature requests, or want to contribute improvements. To contribute, please follow the guidelines in CONTRIBUTING.md.

License

QuVA is licensed under the MIT License, allowing for both personal and commercial use with attribution. - see the LICENSE file for details.