@traversable/schema
    Preparing search index...

    Interface GeneratorOptions<T>

    interface GeneratorOptions<T = never> {
        "*"?: OneOfConstraints;
        any?: {};
        array?: { maxLength?: number; minLength?: number; unbounded?: boolean };
        bigint?: {
            max?: bigint;
            min?: bigint;
            multipleOf?: null | bigint;
            unbounded?: boolean;
        };
        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?: {};
        nan?: {};
        never?: {};
        non_nullable?: {};
        non_nullish?: {};
        non_optional?: {};
        null?: {};
        nullable?: {};
        nullish?: {};
        number?: {
            max?: number;
            min?: number;
            multipleOf?: number;
            unbounded?: boolean;
        } & 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?: { unbounded?: boolean } & StringSharedConstraints & {
            unit?:
                | "grapheme-ascii"
                | "grapheme"
                | "grapheme-composite"
                | "binary"
                | "binary-ascii"
                | Arbitrary<string>;
        };
        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

    *? any? array? bigint? blob? boolean? custom? date? enum? exclude? file? forceInvalid? include? intersect? lazy? literal? loose_object? loose_tuple? map? nan? never? non_nullable? non_nullish? non_optional? null? nullable? nullish? number? object? object_with_rest? optional? promise? record? root? set? sortBias? strict_object? strict_tuple? string? symbol? tuple? tuple_with_rest? undefined? undefinedable? union? unknown? variant? void?

    Properties

    Optional*

    "*"?: OneOfConstraints
    any?: {}
    array?: { maxLength?: number; minLength?: number; unbounded?: boolean }
    bigint?: {
        max?: bigint;
        min?: bigint;
        multipleOf?: null | bigint;
        unbounded?: boolean;
    }
    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?: {}
    nan?: {}
    never?: {}
    non_nullable?: {}
    non_nullish?: {}
    non_optional?: {}
    null?: {}
    nullable?: {}
    nullish?: {}
    number?: {
        max?: number;
        min?: number;
        multipleOf?: number;
        unbounded?: boolean;
    } & 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?: { unbounded?: boolean } & StringSharedConstraints & {
        unit?:
            | "grapheme-ascii"
            | "grapheme"
            | "grapheme-composite"
            | "binary"
            | "binary-ascii"
            | Arbitrary<string>;
    }

    Type declaration

    • Optionalunbounded?: boolean
    • Optionalunit?:
          | "grapheme-ascii"
          | "grapheme"
          | "grapheme-composite"
          | "binary"
          | "binary-ascii"
          | Arbitrary<string>

      A string results from the join between several unitary strings produced by the Arbitrary instance defined by unit. The minLength and maxLength refers to the number of these units composing the string. In other words it does not have to be confound with .length on an instance of string.

      A unit can either be a fully custom Arbitrary or one of the pre-defined options:

      • 'grapheme' - Any printable grapheme as defined by the Unicode standard. This unit includes graphemes that may:
        • Span multiple code points (e.g., '\u{0061}\u{0300}')
        • Consist of multiple characters (e.g., '\u{1f431}')
        • Include non-European and non-ASCII characters.
        • Note: Graphemes produced by this unit are designed to remain visually distinct when joined together.
        • Note: We are relying on the specifications of Unicode 15.
      • 'grapheme-composite' - Any printable grapheme limited to a single code point. This option produces graphemes limited to a single code point.
        • Note: Graphemes produced by this unit are designed to remain visually distinct when joined together.
        • Note: We are relying on the specifications of Unicode 15.
      • 'grapheme-ascii' - Any printable ASCII character.
      • 'binary' - Any possible code point (except half surrogate pairs), regardless of how it may combine with subsequent code points in the produced string. This unit produces a single code point within the full Unicode range (0000-10FFFF).
      • 'binary-ascii' - Any possible ASCII character, including control characters. This unit produces any code point in the range 0000-00FF.
      'grapheme-ascii'

      Since 3.22.0

    symbol?: {}
    tuple?: ArrayConstraints
    tuple_with_rest?: ArrayConstraints
    undefined?: {}
    undefinedable?: {}
    union?: ArrayConstraints
    unknown?: {}
    variant?: ArrayConstraints
    void?: {}

    Settings

    Member Visibility

    On This Page

    Properties