Interface ReadOfflineRegionQueryOptions<T>Experimental

Answering a protocol-neutral Query from a persisted region.

The read path is deliberately narrow. It replays the snapshot a selection captured and refines only the pagination window, because that is the one refinement a stored batch can honour exactly. Everything else fails closed: a construct the region cannot answer raises HonuaCapabilityNotSupportedError, and a selection the region does not cover raises a typed cache miss. Nothing here reaches the network, revalidates, or widens a query, and no result is ever presented as live.

interface ReadOfflineRegionQueryOptions<T> {
    authorizationScopeFingerprint: string;
    bounds?: OfflineRegionBounds;
    expect?: {
        planVersion?: string;
        schemaVersion?: string;
        sourceVersion?: string;
    };
    now?: (() => Date);
    query?: Query<T>;
    selector?: OfflineRegionResourceSelector;
    signal?: AbortSignal;
    staleAfterMs?: number;
    store: OfflineRegionStore;
}

Type Parameters

  • T = Record<string, unknown>

Hierarchy

Properties

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

Properties

Readonly ExperimentalauthorizationScopeFingerprint

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.

Optional Readonly Experimentalbounds

bounds?: OfflineRegionBounds

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

Optional Readonly Experimentalexpect

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

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

Optional Readonlynow

now?: (() => Date)

Optional Readonly Experimentalquery

query?: Query<T>

Protocol-neutral query intent. Omitted means the snapshot's own selection.

Optional Readonly Experimentalselector

selector?: OfflineRegionResourceSelector

Discriminator when a selection stores several feature batches.

Optional Readonly Experimentalsignal

signal?: AbortSignal

Optional Readonly ExperimentalstaleAfterMs

staleAfterMs?: number

Readonly Experimentalstore

store: OfflineRegionStore

Settings

Member Visibility

On This Page

Properties