@adcp/sdk API Reference - v10.0.1
    Preparing search index...

    Interface CanonicalReferenceResolverOptions

    interface CanonicalReferenceResolverOptions {
        cache?: CanonicalReferenceCache;
        timeoutMs?: number;
        maxBodyBytes?: number;
        allowUnsafeHttp?: boolean;
        allowPrivateNetwork?: boolean;
        maxRefDepth?: number;
        maxRefCount?: number;
        maxKeywords?: number;
        validationBudgetMs?: number;
        externalRefDigests?: ExternalRefDigestMap;
        maxTotalRefBytes?: number;
        maxRefResolutionMs?: number;
        mirrorHosts?: readonly string[];
        mirrorHost?: string;
    }
    Index

    Properties

    cache? timeoutMs? maxBodyBytes? allowUnsafeHttp? allowPrivateNetwork? maxRefDepth? maxRefCount? maxKeywords? validationBudgetMs? externalRefDigests? maxTotalRefBytes? maxRefResolutionMs? mirrorHosts? mirrorHost?

    Properties

    cache?: CanonicalReferenceCache

    Caller-owned cache. Defaults to a fresh per-resolver Map.

    timeoutMs?: number

    Default 5_000 ms.

    maxBodyBytes?: number

    Default 1 MiB.

    allowUnsafeHttp?: boolean

    Test/dev-only escape hatch for loopback fixtures. Production callers should leave false.

    allowPrivateNetwork?: boolean

    Test/dev-only escape hatch for loopback/private-network fixtures. Production callers should leave false.

    maxRefDepth?: number

    Default 8 for format_schema $ref walks.

    maxRefCount?: number

    Default 256 for format_schema $ref walks.

    maxKeywords?: number

    Default 10_000 approximate schema keyword/object-key bound.

    validationBudgetMs?: number

    Default 250 ms soft compile-time budget for JSON Schema validation.

    externalRefDigests?: ExternalRefDigestMap

    Required for each external $ref URI in format_schema; keeps transitive schemas immutable.

    maxTotalRefBytes?: number

    Default 8 MiB cumulative cap across external $ref bodies.

    maxRefResolutionMs?: number

    Default 5_000 ms total wall-clock budget across external $ref resolution.

    mirrorHosts?: readonly string[]

    Override the trusted mirror host set for format_schema external $refs.

    mirrorHost?: string

    Single-host convenience override for format_schema external $refs.

    Settings

    Member Visibility

    On This Page

    Properties