@traversable/schema
    Preparing search index...

    Interface GeneratorOptions<T>

    interface GeneratorOptions<T = never> {
        "*"?: OneOfConstraints;
        any?: {};
        array?: { maxLength?: number; minLength?: number };
        bigint?: {
            max: undefined | bigint;
            min: undefined | bigint;
            multipleOf?: null | bigint;
        };
        blob?: {};
        boolean?: {};
        custom?: {};
        date?: {};
        enum?: {};
        exclude?: readonly (string & keyof T)[];
        file?: {};
        forceInvalid?: boolean;
        include?: readonly (string & keyof T)[];
        intersect?: {};
        lazy?: {};
        literal?: {};
        loose_object?: ObjectConstraints;
        loose_tuple?: ArrayConstraints;
        map?: {};
        minDepth?: number;
        nan?: {};
        never?: {};
        non_nullable?: {};
        non_nullish?: {};
        non_optional?: {};
        null?: {};
        nullable?: {};
        nullish?: {};
        number?: { max?: number; min?: number; multipleOf?: number } & DoubleConstraints;
        object?: ObjectConstraints;
        object_with_rest?: ObjectConstraints;
        optional?: {};
        promise?: {};
        record?: DictionaryConstraints;
        root?: string & keyof T | "*";
        set?: {};
        sortBias?: {
            any?: number;
            array?: number;
            bigint?: number;
            blob?: number;
            boolean?: number;
            custom?: number;
            date?: number;
            enum?: number;
            file?: number;
            intersect?: number;
            lazy?: number;
            literal?: number;
            loose_object?: number;
            loose_tuple?: number;
            map?: number;
            nan?: number;
            never?: number;
            non_nullable?: number;
            non_nullish?: number;
            non_optional?: number;
            null?: number;
            nullable?: number;
            nullish?: number;
            number?: number;
            object?: number;
            object_with_rest?: number;
            optional?: number;
            promise?: number;
            record?: number;
            set?: number;
            strict_object?: number;
            strict_tuple?: number;
            string?: number;
            symbol?: number;
            tuple?: number;
            tuple_with_rest?: number;
            undefined?: number;
            undefinedable?: number;
            union?: number;
            unknown?: number;
            variant?: number;
            void?: number;
        };
        strict_object?: ObjectConstraints;
        strict_tuple?: ArrayConstraints;
        string?: StringConstraints;
        symbol?: {};
        tuple?: ArrayConstraints;
        tuple_with_rest?: ArrayConstraints;
        undefined?: {};
        undefinedable?: {};
        union?: ArrayConstraints;
        unknown?: {};
        variant?: ArrayConstraints;
        void?: {};
    }

    Type Parameters

    • T = never

    Hierarchy

    • Partial<OptionsBase<T>>
    • Constraints
      • GeneratorOptions
    Index

    Properties

    "*"?: OneOfConstraints
    any?: {}
    array?: { maxLength?: number; minLength?: number }
    bigint?: {
        max: undefined | bigint;
        min: undefined | bigint;
        multipleOf?: null | bigint;
    }
    blob?: {}
    boolean?: {}
    custom?: {}
    date?: {}
    enum?: {}
    exclude?: readonly (string & keyof T)[]
    file?: {}
    forceInvalid?: boolean
    include?: readonly (string & keyof T)[]
    intersect?: {}
    lazy?: {}
    literal?: {}
    loose_object?: ObjectConstraints
    loose_tuple?: ArrayConstraints
    map?: {}
    minDepth?: number
    nan?: {}
    never?: {}
    non_nullable?: {}
    non_nullish?: {}
    non_optional?: {}
    null?: {}
    nullable?: {}
    nullish?: {}
    number?: { max?: number; min?: number; multipleOf?: number } & DoubleConstraints
    object?: ObjectConstraints
    object_with_rest?: ObjectConstraints
    optional?: {}
    promise?: {}
    record?: DictionaryConstraints
    root?: string & keyof T | "*"
    set?: {}
    sortBias?: {
        any?: number;
        array?: number;
        bigint?: number;
        blob?: number;
        boolean?: number;
        custom?: number;
        date?: number;
        enum?: number;
        file?: number;
        intersect?: number;
        lazy?: number;
        literal?: number;
        loose_object?: number;
        loose_tuple?: number;
        map?: number;
        nan?: number;
        never?: number;
        non_nullable?: number;
        non_nullish?: number;
        non_optional?: number;
        null?: number;
        nullable?: number;
        nullish?: number;
        number?: number;
        object?: number;
        object_with_rest?: number;
        optional?: number;
        promise?: number;
        record?: number;
        set?: number;
        strict_object?: number;
        strict_tuple?: number;
        string?: number;
        symbol?: number;
        tuple?: number;
        tuple_with_rest?: number;
        undefined?: number;
        undefinedable?: number;
        union?: number;
        unknown?: number;
        variant?: number;
        void?: number;
    }
    strict_object?: ObjectConstraints
    strict_tuple?: ArrayConstraints
    string?: StringConstraints
    symbol?: {}
    tuple?: ArrayConstraints
    tuple_with_rest?: ArrayConstraints
    undefined?: {}
    undefinedable?: {}
    union?: ArrayConstraints
    unknown?: {}
    variant?: ArrayConstraints
    void?: {}