Getting started

Installation

Install @hiperf/validate with your favorite package manager:

npm

npm i @hiperf/validate

yarn

yarn add @hiperf/validate

pnpm

pnpm i @hiperf/validate

bun

bun add @hiperf/validate

Usage

import { validate } from '@hiperf/validate';

const schema = {
    name: {
        minLength: 3,
        isString: true,
    },
    age: {
        min: {
            value: 18,
            error: 'Minimal age is 18 y.o.' // Custom error message
        },
        isNumber: true
    },
    email: {
        isEmail: true,
    },
	message: {
		custom(v) {
			const errors = [];

			if (!/🐈|😺|😸|😻|😽/.test(v))
				errors.push('Message should contain cat emoji! 😾');

			return errors;
		}
	}
};

const data = {
    name: 'John Doe, Jr.',
    age: 15,
    email: 'john.doe.jr@example.com',
	message: '🐶 woof!'
};

const { isValid, errors } = validate(schema, data);
// isValid = false 
// errors = [
//     'Minimal age is 18 y.o.',
//     'Message should contain cat emoji! 😾'
// ]

TIP

Both ESM and CJS modules is supported.

ESM

import { validate } from '@hiperf/validate';

CJS

const { validate } = require('@hiperf/validate');