Interface Schema<T>

Type-safe runtime validator and transformer for a value of type T.

interface Schema<T> {
    assert(value: unknown): asserts value is T;
    nullable(): Schema<null | T>;
    optional(): Schema<undefined | T>;
    parse(value: unknown): T;
    refine(
        pred: (v: T) => boolean,
        message: string,
        code?: ValidationIssueCode,
    ): Schema<T>;
    required(): this;
    safeParse(value: unknown): SafeParseResult<T>;
}

Type Parameters

T

Index

Methods

assert nullable optional parse refine required safeParse

Methods

assert

assert(value: unknown): asserts value is T
Validates the value in place, throwing if it does not satisfy the schema.
Parameters
- value: unknown
  Raw input to validate.
Returns asserts value is T
Throws
ValidationError Thrown when validation fails.
- Defined in tmp/package/dist/index.d.ts:2798

nullable

nullable(): Schema<null | T>
Allows null in addition to the current schema.

Returns Schema<null | T>
A schema permitting null.
- Defined in tmp/package/dist/index.d.ts:2823

optional

optional(): Schema<undefined | T>
Allows undefined in addition to the current schema.

Returns Schema<undefined | T>
A schema permitting undefined.
- Defined in tmp/package/dist/index.d.ts:2811

parse

parse(value: unknown): T
Validates and returns a value when all schema constraints pass.
Parameters
- value: unknown
  Raw input to validate.
Returns T
The parsed value if validation succeeds.

Throws
ValidationError Thrown when validation fails.
- Defined in tmp/package/dist/index.d.ts:2791

refine

refine(
    pred: (v: T) => boolean,
    message: string,
    code?: ValidationIssueCode,
): Schema<T>
Adds a custom predicate to refine acceptable values.
Parameters
- pred: (v: T) => boolean
  Predicate returning true when the value is valid.
- message: string
  Human friendly description shown on failure.
- Optionalcode: ValidationIssueCode
  Optional machine readable identifier for the failure.
Returns Schema<T>
A schema reflecting the additional refinement.
- Defined in tmp/package/dist/index.d.ts:2832

required

required(): this
Removes undefined from the accepted set of values.

Returns this
The current schema with undefined disallowed.
- Defined in tmp/package/dist/index.d.ts:2817

safeParse

safeParse(value: unknown): SafeParseResult<T>
Attempts to parse a value without throwing.
Parameters
- value: unknown
  Raw input to validate.
Returns SafeParseResult<T>
Success with parsed data or failure with validation issues.
- Defined in tmp/package/dist/index.d.ts:2805