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

    Interface WalkOptions<T>

    Options accepted by walk. Use to inject meta overrides, field-level overrides, the root document for cross-document $ref resolution, a diagnostics sink, and an external $ref resolver.

    WalkOptions is generic in the schema's value type so callers that walk a typed schema can carry FieldOverrides<T> through. The default T = unknown preserves the loose runtime record shape for existing non-generic callers — Record<string, unknown>.

    interface WalkOptions<T = unknown> {
        componentMeta?: SchemaMeta;
        rootMeta?: SchemaMeta;
        fieldOverrides?: unknown extends T
            ? Record<string, unknown>
            | undefined
            : FieldOverrides<T> | undefined;
        rootDocument?: Record<string, unknown>;
        diagnostics?: DiagnosticsOptions;
        externalResolver?: ExternalResolver;
    }

    Type Parameters

    • T = unknown
    Index

    Properties

    componentMeta? rootMeta? fieldOverrides? rootDocument? diagnostics? externalResolver?

    Properties

    componentMeta?: SchemaMeta
    rootMeta?: SchemaMeta
    fieldOverrides?: unknown extends T
        ? Record<string, unknown>
        | undefined
        : FieldOverrides<T> | undefined

    Nested field overrides — same shape as the schema.

    Typed against FieldOverrides<T> when a schema value type is supplied; falls back to Record<string, unknown> for the default T = unknown so the loose runtime shape continues to compile.

    rootDocument?: Record<string, unknown>

    The root document for $ref resolution.

    diagnostics?: DiagnosticsOptions

    Diagnostics channel for surfacing silent fallbacks.

    externalResolver?: ExternalResolver

    Sync resolver for external $ref URIs.

    Settings

    Member Visibility

    On This Page

    Properties