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

    Interface ObjectField

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

    interface ObjectField {
        editability: Editability;
        meta: SchemaMeta;
        isOptional?: boolean;
        isNullable?: boolean;
        defaultValue?: unknown;
        examples?: unknown[];
        type: "object";
        constraints: ObjectConstraints;
        fields: Record<string, WalkedField>;
        requiredFields: string[];
        patternProperties?: Record<string, WalkedField>;
        additionalPropertiesClosed?: boolean;
        additionalPropertiesSchema?: WalkedField;
        dependentSchemas?: Record<string, WalkedField>;
        dependentRequired?: Record<string, string[]>;
        unevaluatedProperties?: WalkedField;
        unevaluatedPropertiesClosed?: boolean;
        propertyNames?: WalkedField;
    }

    Hierarchy (View Summary)

    Index

    Properties

    editability meta isOptional? isNullable? defaultValue? examples? type constraints fields requiredFields patternProperties? additionalPropertiesClosed? additionalPropertiesSchema? dependentSchemas? dependentRequired? unevaluatedProperties? unevaluatedPropertiesClosed? propertyNames?

    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: "object"
    constraints: ObjectConstraints
    fields: Record<string, WalkedField>

    Map of property name → walked sub-schema.

    requiredFields: string[]

    Property names declared in required.

    patternProperties?: Record<string, WalkedField>

    Regex-keyed sub-schemas from patternProperties.

    additionalPropertiesClosed?: boolean

    Whether additionalProperties is explicitly false (closed).

    additionalPropertiesSchema?: WalkedField

    Schema for additional properties when not false and not a Record.

    dependentSchemas?: Record<string, WalkedField>

    Property-presence-activated sub-schemas from dependentSchemas.

    dependentRequired?: Record<string, string[]>

    Property-presence-conditional required fields from dependentRequired.

    unevaluatedProperties?: WalkedField

    Constraint schema for unevaluated properties.

    unevaluatedPropertiesClosed?: boolean

    Whether unevaluatedProperties is explicitly false.

    propertyNames?: WalkedField

    Schema constraining property names (from propertyNames).

    Settings

    Member Visibility

    On This Page

    Properties