ThatOneCalculator / vld

A fast type validator

Vld

A fast JSON schema complaint type validator.

This library implements a subset of JSON schema draft 7.

Usage

import { schema, compile } from '@bit-js/vld';

// Type hint for JSON schema
const Username = schema.create({
    type: 'string',
    minLength: 3,
    maxLength: 25
});

// Extract type from schema
export type Username = schema.Infer<typeof Username>;

// Compile a schema to an assertion function
const isUser = compile.assert({
    type: 'object',
    properties: {
        name: Username,
        age: { type: 'integer', minimum: 1, maximum: 100 },
        nickname: Username
    },
    required: ['name', 'age']
});

// Example usage with data validation
if (isUser(user)) {
    user.name; // string
    user.age; // number
    user.nickname; // string | undefined
}

For compile a schema to an assertion function ahead of time:

const code = `const isUser = (()=>{${compile.inspectAssert(schema).code}})();`;