Interface HonuaMetadataRequestOptions

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

Hierarchy (view full)

Properties

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

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.