@honua/sdk-js
    Preparing search index...

    Interface HonuaMetadataRequestOptions

    interface HonuaMetadataRequestOptions {
        cache?: HonuaCacheReadMode;
        maxResponseBytes?: number;
        refresh?: boolean;
        signal?: AbortSignal;
        staleIfError?: boolean;
        staleIfErrorMs?: number;
        ttlMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    cache? maxResponseBytes? refresh? signal? staleIfError? staleIfErrorMs? ttlMs?

    Properties

    cache?: HonuaCacheReadMode

    default reads and writes the adapter metadata cache. bypass skips cache lookup and write-through for endpoints that support SDK-local caching.

    maxResponseBytes?: number

    Maximum decoded response-body bytes accepted before metadata parsing. Adapters that consume bounded discovery documents set this explicitly so a missing or dishonest Content-Length cannot turn metadata discovery into an unbounded allocation. The limit is enforced while streaming the body, not only from response headers.

    refresh?: boolean

    Revalidate even when an SDK-local metadata entry is present. Adapters send conditional validators when available and report refreshed on success.

    signal?: AbortSignal
    staleIfError?: boolean

    Allow a cached metadata entry to be returned as stale when refresh fails. Defaults to true; ignored when no cached metadata entry exists.

    staleIfErrorMs?: number

    Optional stale fallback window surfaced to callers in HonuaCacheState.

    ttlMs?: number

    Optional freshness budget surfaced to callers in HonuaCacheState.

    Settings

    Member Visibility

    On This Page

    Properties