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

    Interface RecordField

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

    interface RecordField {
        editability: Editability;
        meta: SchemaMeta;
        isOptional?: boolean;
        isNullable?: boolean;
        defaultValue?: unknown;
        examples?: unknown[];
        type: "record";
        constraints: ObjectConstraints;
        keyType: WalkedField;
        valueType: WalkedField;
    }

    Hierarchy (View Summary)

    Index

    Properties

    editability meta isOptional? isNullable? defaultValue? examples? type constraints keyType valueType

    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: "record"
    constraints: ObjectConstraints
    keyType: WalkedField

    Key name validation schema (from propertyNames).

    valueType: WalkedField

    Value schema (from additionalProperties).

    Settings

    Member Visibility

    On This Page

    Properties