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

    Interface OfflineRegionStoreReadOptions

    Gate inputs plus the store a read will resolve its identity against.

    interface OfflineRegionStoreReadOptions {
        authorizationScopeFingerprint: string;
        bounds?: OfflineRegionBounds;
        expect?: {
            planVersion?: string;
            schemaVersion?: string;
            sourceVersion?: string;
        };
        now?: () => Date;
        query?: Query<Record<string, unknown>>;
        signal?: AbortSignal;
        staleAfterMs?: number;
        store: OfflineRegionStore;
    }

    Hierarchy (View Summary)

    Index

    Properties

    authorizationScopeFingerprint bounds? expect? now? query? signal? staleAfterMs? store

    Properties

    authorizationScopeFingerprint: string

    The caller's current authorization-scope partition input. Its digest must equal the region's, so a scope change can never serve another principal's cached bytes.

    bounds?: OfflineRegionBounds

    Extent the caller is asking about. Must equal the region's own extent.

    expect?: {
        planVersion?: string;
        schemaVersion?: string;
        sourceVersion?: string;
    }

    Versions the caller expects. A drift fails closed instead of serving stale schema.

    now?: () => Date
    query?: Query<Record<string, unknown>>

    Protocol-neutral query the snapshot was planned with. Every resource of a snapshot is identified against its selection's canonical query, so a tile or document planned under a query must be read back under the same one.

    signal?: AbortSignal
    staleAfterMs?: number
    store: OfflineRegionStore

    Settings

    Member Visibility

    On This Page

    Properties