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

    Interface ChunkSource

    Where MultiLevelCachingStore gets its bytes.

    interface ChunkSource {
        identity: string;
        describe: string;
        get(key: string, signal?: AbortSignal): Promise<ChunkFetchOutcome>;
        probeIdentityToken(
            options: { signal?: AbortSignal; timeoutMsOverride?: number },
        ): Promise<RemoteValidationToken | null>;
        dispose(): void;
    }

    Implemented by

    Index
    identity describe
    get probeIdentityToken dispose
    identity: string

    Stable identity of the thing being read, used to derive the OPFS bucket.

    NEVER normalized: scene.luxar.zarr.zip and scene.luxar.zarr/ are different sources with different key namespaces, and collapsing them into one bucket would let an archive read a directory's cached members (and vice versa) with no failure to notice.

    describe: string

    Human-readable label for logs and the OPFS index metadata.

    • Re-read the source's identity token, bypassing every cache tier, so the store can tell "same dataset" from "something else now serves this address". null means the source could not answer — which is not evidence of a change (see the TTL handling in validateCache).

      Parameters

      • options: { signal?: AbortSignal; timeoutMsOverride?: number }

      Returns Promise<RemoteValidationToken | null>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods