Validator Lite

Typed schema based validation with low calories

Really simple and lightweight validation library for JavaScript. Used by @adonisjs/env for validating environment variables.

Installation

Install the module from npm registry as follows:

npm install @poppinss/validator-lite

# yarn
yarn add @poppinss/validator-lite

# pnpm 
pnpm add @poppinss/validator-lite

Basic usage

The following example shows how to use the validator :

1import { schema } from '@poppinss/validator-lite'
2
3/**
4 * Define a schema
5 */
6const userSchema = {
7  name: schema.string(),
8  age: schema.number(),
9  email: schema.string.optional(),
10  website: schema.string({ format: 'url' }),
11}
12
13/**
14 * Define the data
15 */
16const data = {
17  name: 'John doe',
18  age: 25,
19  website: 'https://adonisjs.com',
20}
21
22/**
23 * Validate the data
24 */
25for (let [key, fn] of Object.entries(userSchema)) {
26  fn(key, user[key])
27}

API

Following is the list of available methods :

schema.string

Validates the value to check if it exists and if it is a valid string. Empty strings fail the validations, and you must use the optional variant to allow empty strings.

1{
2  APP_KEY: schema.string()
3}
4// Mark it as optional
5{
6  APP_KEY: schema.string.optional()
7}

You can also force the value to have one of the pre-defined formats.

1// Must be a valid host (url or ip)
2schema.string({ format: 'host' })
3// Must be a valid URL
4schema.string({ format: 'url' })
5// Must be a valid email address
6schema.string({ format: 'email' })

When validating the url format, you can also define additional options to force/ignore the tld and protocol.

1schema.string({ format: 'url', tld: false, protocol: false })

---

schema.boolean

Enforces the value to be a valid string representation of a boolean. Following values are considered as valid booleans and will be converted to true or false.

• '1', 'true' are casted to Boolean(true)
• '0', 'false' are casted to Boolean(false)

1{
2  CACHE_VIEWS: schema.boolean()
3}
4// Mark it as optional
5{
6  CACHE_VIEWS: schema.boolean.optional()
7}

---

schema.number

Enforces the value to be a valid string representation of a number.

1{
2  PORT: schema.number()
3}
4// Mark it as optional
5{
6  PORT: schema.number.optional()
7}

---

schema.enum

Forces the value to be one of the pre-defined values.

1{
2  MY_ENUM: schema.enum(['development', 'production'] as const)
3}
4// Mark it as optional
5{
6  MY_ENUM: schema.enum.optional(['development', 'production'] as const)
7}

---

Custom functions

For every other validation use case, you can define your custom functions.

1{
2  PORT: (key, value) => {
3    if (!value) {
4      throw new Error('Value for PORT is required')
5    }
6    
7    if (isNaN(Number(value))) {
8      throw new Error('Value for PORT must be a valid number')    
9    }
10    return Number(value)
11  }
12}

• Make sure to always return the value after validating it.
• The return value can be different from the initial input value.