@karmaniverous/get-dotenv
    Preparing search index...

    Interface RegistryToJSONSchemaParams

    Parameters for the toJSONSchema function when passing a registry.

    interface RegistryToJSONSchemaParams {
        cycles?: "ref" | "throw";
        io?: "input" | "output";
        metadata?: $ZodRegistry<
            Record<string, any>,
            z.core.$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
        >;
        override?: (
            ctx: {
                jsonSchema: z.core.JSONSchema.JSONSchema;
                path: (string | number)[];
                zodSchema: $ZodTypes;
            },
        ) => void;
        reused?: "ref"
        | "inline";
        target?:
            | "draft-04"
            | "draft-07"
            | "draft-2020-12"
            | "openapi-3.0"
            | {} & string;
        unrepresentable?: "any"
        | "throw";
        uri?: (id: string) => string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cycles? io? metadata? override? reused? target? unrepresentable? uri?

    Properties

    cycles?: "ref" | "throw"
    io?: "input" | "output"

    Whether to extract the "input" or "output" type. Relevant to transforms, defaults, coerced primitives, etc.

    • "output" — Default. Convert the output schema.
    • "input" — Convert the input schema.
    metadata?: $ZodRegistry<
        Record<string, any>,
        z.core.$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
    >

    A registry used to look up metadata for each schema. Any schema with an id property will be extracted as a $def.

    globalRegistry
    override?: (
        ctx: {
            jsonSchema: z.core.JSONSchema.JSONSchema;
            path: (string | number)[];
            zodSchema: $ZodTypes;
        },
    ) => void

    Arbitrary custom logic that can be used to modify the generated JSON Schema.

    reused?: "ref" | "inline"
    target?: "draft-04" | "draft-07" | "draft-2020-12" | "openapi-3.0" | {} & string

    The JSON Schema version to target.

    • "draft-2020-12" — Default. JSON Schema Draft 2020-12
    • "draft-07" — JSON Schema Draft 7
    • "draft-04" — JSON Schema Draft 4
    • "openapi-3.0" — OpenAPI 3.0 Schema Object
    unrepresentable?: "any" | "throw"

    How to handle unrepresentable types.

    • "throw" — Default. Unrepresentable types throw an error
    • "any" — Unrepresentable types become {}
    uri?: (id: string) => string

    Settings

    Member Visibility

    On This Page

    Properties