Luxar Viewer API Documentation - v2026.10.19
    Preparing search index...

    Interface CachedArrayHooks

    Optional per-wrap accessors consulted by the L0 proxy. All are thunks that read the owning loader's transient state at getChunk time.

    interface CachedArrayHooks {
        getProbe?: () => ResidencyProbe | null;
        getSignal?: () => AbortSignal | null;
        getOrigin?: () => string;
    }
    Index
    getProbe? getSignal? getOrigin?
    getProbe?: () => ResidencyProbe | null

    Accessor for the currently-active residency probe. Called on every getChunk to report hit/miss. Returning null (the default / when no load is in flight) disables reporting — this is how prefetch traffic is kept from contaminating a demand load's signal.

    getSignal?: () => AbortSignal | null

    Accessor for the currently-active per-update AbortSignal. Called on every getChunk; if it returns an aborted signal the call throws (AbortError) BEFORE any L0 lookup, cache fetch, or Blosc decode — so a superseded updateView bails on the warm-cache hit path too (zarrita's own throwIfAborted only fires between chunks of a multi-chunk selection). When the call itself carries no signal, this one is also the caller's WAITER signal: aborting it rejects only this caller — a decode shared with a still-live caller keeps running (see wrapWithCache).

    getOrigin?: () => string

    Accessor naming who triggered a miss decode (decode.count.<origin> perf counter). Consulted only on a genuine miss, and only when the call's AbortSignal carries no tagSignalOrigin tag; defaults to 'foreground'. Instrumentation only — never changes what is fetched or decoded.

    Settings
    Member Visibility

    On This Page
    Properties