@traversable/schema
    Preparing search index...

    Variable SchemaGeneratorConst

    SchemaGenerator: <
        Options extends
            Options<
                {
                    array: [1000, unknown, Bounds_array];
                    boolean: [15];
                    const: [
                        550,
                        | string
                        | number
                        | boolean
                        | (string | number | boolean)[]
                        | Record<string, string | number | boolean>,
                    ];
                    enum: [350, (string | number | boolean)[]];
                    integer: [100, Bounds_int];
                    intersection: [
                        6000,
                        [[7500, [string, unknown][]], [7500, [string, unknown][]]],
                    ];
                    never: [35];
                    null: [40];
                    number: [200, Bounds_number];
                    object: [7500, [string, unknown][], string[]];
                    record: [7000, unknown, undefined] | [7000, unknown, [string, unknown]];
                    string: [250, Bounds_string];
                    tuple: [8000, unknown[]];
                    union: [8500, unknown[]];
                    unknown: [55];
                },
            >,
    >(
        ...a: [
            options?: Options,
            overrides?: Partial<
                Base<
                    {
                        array: [1000, unknown, Bounds_array];
                        boolean: [15];
                        const: [
                            550,
                            | string
                            | number
                            | boolean
                            | (string | number | boolean)[]
                            | Record<string, string | number | boolean>,
                        ];
                        enum: [350, (string | number | boolean)[]];
                        integer: [100, Bounds_int];
                        intersection: [
                            6000,
                            [[7500, [(...), (...)][]], [7500, [(...), (...)][]]],
                        ];
                        never: [35];
                        null: [40];
                        number: [200, Bounds_number];
                        object: [7500, [string, unknown][], string[]];
                        record: [7000, unknown, undefined] | [7000, unknown, [string, unknown]];
                        string: [250, Bounds_string];
                        tuple: [8000, unknown[]];
                        union: [8500, unknown[]];
                        unknown: [55];
                    },
                    byTypeName,
                >,
            >,
        ],
    ) => Arbitrary = ...

    A zod schema generator that can be interpreted to produce an arbitrary zod schema (v4, classic).

    The generator supports a wide range of configuration options that are discoverable via the optional options argument.

    Many of those options are forwarded to the corresponding fast-check arbitrary.

    Note: support for options.minDepth is experimental. If you use it, be advised that even with a minimum depth of 1, the schemas produced will be quite large. Using this option in your CI/CD pipeline is not recommended.

    See also:

    Type declaration

      • <
            Options extends
                Options<
                    {
                        array: [1000, unknown, Bounds_array];
                        boolean: [15];
                        const: [
                            550,
                            | string
                            | number
                            | boolean
                            | (string | number | boolean)[]
                            | Record<string, string | number | boolean>,
                        ];
                        enum: [350, (string | number | boolean)[]];
                        integer: [100, Bounds_int];
                        intersection: [
                            6000,
                            [[7500, [string, unknown][]], [7500, [string, unknown][]]],
                        ];
                        never: [35];
                        null: [40];
                        number: [200, Bounds_number];
                        object: [7500, [string, unknown][], string[]];
                        record: [7000, unknown, undefined] | [7000, unknown, [string, unknown]];
                        string: [250, Bounds_string];
                        tuple: [8000, unknown[]];
                        union: [8500, unknown[]];
                        unknown: [55];
                    },
                >,
        >(
            ...a: [
                options?: Options,
                overrides?: Partial<
                    Base<
                        {
                            array: [1000, unknown, Bounds_array];
                            boolean: [15];
                            const: [
                                550,
                                | string
                                | number
                                | boolean
                                | (string | number | boolean)[]
                                | Record<string, string | number | boolean>,
                            ];
                            enum: [350, (string | number | boolean)[]];
                            integer: [100, Bounds_int];
                            intersection: [
                                6000,
                                [[7500, [(...), (...)][]], [7500, [(...), (...)][]]],
                            ];
                            never: [35];
                            null: [40];
                            number: [200, Bounds_number];
                            object: [7500, [string, unknown][], string[]];
                            record: [7000, unknown, undefined] | [7000, unknown, [string, unknown]];
                            string: [250, Bounds_string];
                            tuple: [8000, unknown[]];
                            union: [8500, unknown[]];
                            unknown: [55];
                        },
                        byTypeName,
                    >,
                >,
            ],
        ): Arbitrary

      • Type Parameters

        • Options extends Options<
              {
                  array: [1000, unknown, Bounds_array];
                  boolean: [15];
                  const: [
                      550,
                      | string
                      | number
                      | boolean
                      | (string | number | boolean)[]
                      | Record<string, string | number | boolean>,
                  ];
                  enum: [350, (string | number | boolean)[]];
                  integer: [100, Bounds_int];
                  intersection: [
                      6000,
                      [[7500, [string, unknown][]], [7500, [string, unknown][]]],
                  ];
                  never: [35];
                  null: [40];
                  number: [200, Bounds_number];
                  object: [7500, [string, unknown][], string[]];
                  record: [7000, unknown, undefined] | [7000, unknown, [string, unknown]];
                  string: [250, Bounds_string];
                  tuple: [8000, unknown[]];
                  union: [8500, unknown[]];
                  unknown: [55];
              },
          >

        Parameters

        • ...a: [
              options?: Options,
              overrides?: Partial<
                  Base<
                      {
                          array: [1000, unknown, Bounds_array];
                          boolean: [15];
                          const: [
                              550,
                              | string
                              | number
                              | boolean
                              | (string | number | boolean)[]
                              | Record<string, string | number | boolean>,
                          ];
                          enum: [350, (string | number | boolean)[]];
                          integer: [100, Bounds_int];
                          intersection: [
                              6000,
                              [[7500, [(...), (...)][]], [7500, [(...), (...)][]]],
                          ];
                          never: [35];
                          null: [40];
                          number: [200, Bounds_number];
                          object: [7500, [string, unknown][], string[]];
                          record: [7000, unknown, undefined] | [7000, unknown, [string, unknown]];
                          string: [250, Bounds_string];
                          tuple: [8000, unknown[]];
                          union: [8500, unknown[]];
                          unknown: [55];
                      },
                      byTypeName,
                  >,
              >,
          ]

        Returns Arbitrary

    // TODO

    Settings

    Member Visibility

    On This Page

    <a href="#" class="tsd-kind-variable">zx.SchemaGenerator</a>