schema-components - v3.7.0
    Preparing search index...

    Interface DiscriminatedUnionField

    Properties common to every WalkedField variant. The type field acts as the discriminant for the tagged union.

    interface DiscriminatedUnionField {
        editability: Editability;
        meta: SchemaMeta;
        isOptional?: boolean;
        isNullable?: boolean;
        defaultValue?: unknown;
        examples?: unknown[];
        type: "discriminatedUnion";
        constraints: Record<string, never>;
        options: WalkedField[];
        discriminator: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    editability meta isOptional? isNullable? defaultValue? examples? type constraints options discriminator

    Properties

    editability: Editability
    meta: SchemaMeta
    isOptional?: boolean

    Whether the field is optional (not in required).

    isNullable?: boolean

    Whether the field is nullable (anyOf [T, null] or type: ["...", "null"]).

    defaultValue?: unknown

    Default value from the schema's default keyword.

    examples?: unknown[]

    Example values from the schema's examples keyword.

    type: "discriminatedUnion"
    constraints: Record<string, never>
    options: WalkedField[]

    The union options.

    discriminator: string

    Property name that discriminates between options.

    Settings

    Member Visibility

    On This Page

    Properties