succulent/build/schema.d.ts

Powerful and easy runtime type checking

import type { ErrorRef } from "./ref";
export declare type Type<X> = Schema.Unwrap<X>;
export declare namespace Schema {
    type Unwrap<X> = X extends Schema<infer T> ? T : never;
    type UnwrapAll<X> = {
        [K in keyof X]: Unwrap<X[K]>;
    };
    type Wrap<X> = SchemaBase<X>;
    type WrapAll<X> = {
        [K in keyof X]: Wrap<X[K]>;
    };
}
export declare type SchemaBase<T> = Schema<T> | (T extends LiteralSchema ? T : never);
export declare type LiteralSchema = string | number | bigint | symbol | boolean | null | undefined;
declare type Filter<T> = (x: T) => boolean;
interface SchemaOptions<T> {
    displayName?: string;
    iter?: () => Iterator<T>;
}
export declare class Schema<T> {
    static check<T>(base: SchemaBase<T>, x: unknown): x is T;
    static is<T>(base: SchemaBase<T>, x: unknown, ref?: ErrorRef): x is T;
    static displayName<T>(base: SchemaBase<T>): string;
    static every<T>(base: SchemaBase<T>, predicate: (value: T, index: number, array: T[]) => boolean): boolean;
    static from<T>(base: SchemaBase<T>): Schema<T>;
    /**
     * Used to iterate through all possible values accepted by the schema,
     * for certain finite types
     */
    readonly [Symbol.iterator]: () => Iterator<T>;
    private readonly _check;
    readonly displayName: string;
    constructor(base: ((x: unknown) => x is T) | SchemaBase<T>, options?: SchemaOptions<T>);
    /**
     * A method used to check if a given value matches the schema
     */
    check(x: unknown): x is T;
    that(...filters: Array<Filter<T>>): Schema<T>;
    toString(): string;
}
export {};