Class SchemaValidator<TInput, TOutput>

Validates a form object field by field. Create one with createSchemaValidator, or with new SchemaValidator() and SchemaValidator.field.

Type Parameters

TInput extends Record<string, unknown> = Record<string, unknown>
TOutput extends Record<string, unknown> = TInput

Index

Constructors

Methods

Constructors

constructor

new SchemaValidator<
    TInput extends Record<string, unknown> = Record<string, unknown>,
    TOutput extends Record<string, unknown> = TInput,
>(
    schemaMap?: Partial<
        Record<
            keyof TInput,
            ValidatorRule<unknown>
            | readonly ValidatorRule<unknown>[],
        >,
    >,
): SchemaValidator<TInput, TOutput>
Type Parameters
- TInput extends Record<string, unknown> = Record<string, unknown>
- TOutput extends Record<string, unknown> = TInput
Parameters
- OptionalschemaMap: Partial<
      Record<
          keyof TInput,
          ValidatorRule<unknown>
          | readonly ValidatorRule<unknown>[],
      >,
  >
Returns SchemaValidator<TInput, TOutput>
- Defined in schema/validator.ts:64

Methods

field

field(name: keyof TInput, ...rules: ValidatorRule<unknown>[]): this
Adds rules to a field, after any it already has. Returns the validator for chaining.
Parameters
- name: keyof TInput
  Field name in the form object.
- ...rules: ValidatorRule<unknown>[]
  Rules to append, checked in order.
Returns this
The same validator.
Example
```
const form = new SchemaValidator().field('nic', rules.required(), rules.nic());
form.validate({}).errorCodes; // { nic: 'REQUIRED' }
```
- Defined in schema/validator.ts:89

validate

validate(data: unknown): SchemaValidationResult<TOutput>
Checks every field. Each field stops at its first failing rule. Non-object input, arrays, and class instances fail with code SCHEMA_INVALID_ROOT instead of throwing.
Parameters
- data: unknown
  Form data to check, usually a parsed request body.
Returns SchemaValidationResult<TOutput>
{ isValid: true, data } with every field's parsed value, or { isValid: false, data } with only the fields that passed. Both include errors (messages), errorCodes, and errorList, keyed by field.
- Defined in schema/validator.ts:103