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

    Interface EnumField

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

    interface EnumField {
        editability: Editability;
        meta: SchemaMeta;
        isOptional?: boolean;
        isNullable?: boolean;
        defaultValue?: unknown;
        examples?: unknown[];
        type: "enum";
        constraints: Record<string, never>;
        enumValues: unknown[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    editability meta isOptional? isNullable? defaultValue? examples? type constraints enumValues

    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: "enum"
    constraints: Record<string, never>
    enumValues: unknown[]

    Enum values from JSON Schema enum. Per Draft 2020-12 §6.1.2, enum accepts an array of arbitrary JSON values — not only primitives. Object and array values are preserved verbatim.

    Settings

    Member Visibility

    On This Page

    Properties