Configuration

Validation Schemas

Instead of validating fields one by one, you can define a schema to handle multiple validations at once.

Creating a Validation Schema

Now you can create structured validation using vboxSchema instead of calling each validator separately.

import { vboxSchema, validator } from "validation-box";
 
const userSchema = new vboxSchema({
  username: validator.username({ minLength: 5, bannedWords: ["admin", "root"] }),
  email: validator.email({ allowedDomains: ["gmail.com", "outlook.com"] }),
  password: validator.password({ minLength: 8, allowSpecialChars: "!@#$%^&*" }),
});
 
const result = userSchema.validate({
  username: "validUser",
  email: "user@gmail.com",
  password: "Secure@123",
});
 
console.log(result);

Schema Configuration Options

When defining a schema with vboxSchema, each field can be customized using various options. These options allow you to set constraints, such as minimum and maximum length, allowed special characters, and even restricted words.

The table below outlines the available configuration options for different validation fields:

Configuration Guide

Validation Box lets you fully customize your validation rules. Below are some key options you can configure.

Validation options table

One of the trufuns of validation-box over other libraries is country-specific validation.

Currently the list is short, but functional. We are working to make it as global as possible. Want to help us?

Validation options table (Countries)