Interface HonuaMetadataRequestOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional Readonlycache

cache?: HonuaCacheReadMode

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

Optional ReadonlymaxResponseBytes

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.

Optional Readonlyrefresh

refresh?: boolean

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

Optional Readonlysignal

signal?: AbortSignal

Optional ReadonlystaleIfError

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.

Optional ReadonlystaleIfErrorMs

staleIfErrorMs?: number

Optional stale fallback window surfaced to callers in HonuaCacheState.

Optional ReadonlyttlMs

ttlMs?: number

Optional freshness budget surfaced to callers in HonuaCacheState.

Settings

Member Visibility

On This Page

Properties