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

    Interface ArrayField

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

    interface ArrayField {
        editability: Editability;
        meta: SchemaMeta;
        isOptional?: boolean;
        isNullable?: boolean;
        defaultValue?: unknown;
        examples?: unknown[];
        type: "array";
        constraints: ArrayConstraints;
        element?: WalkedField;
        contains?: WalkedField;
        unevaluatedItems?: WalkedField;
        unevaluatedItemsClosed?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    editability meta isOptional? isNullable? defaultValue? examples? type constraints element? contains? unevaluatedItems? unevaluatedItemsClosed?

    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: "array"
    constraints: ArrayConstraints
    element?: WalkedField

    The element sub-schema.

    contains?: WalkedField

    Walked schema that at least one array item must match (contains keyword). Constrains element membership at runtime; paired with minContains/maxContains for cardinality.

    unevaluatedItems?: WalkedField

    Walked schema for unevaluated items.

    unevaluatedItemsClosed?: boolean

    Whether unevaluatedItems is explicitly false (no extras permitted beyond the items evaluated by items/prefixItems/ contains). Parallel to additionalPropertiesClosed and unevaluatedPropertiesClosed on ObjectField.

    Settings

    Member Visibility

    On This Page

    Properties