Interface ReadOfflineRegionMetadataOptions

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

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

Hierarchy (view full)

Properties

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

Properties

ReadonlyauthorizationScopeFingerprint

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 Readonlybounds

bounds?: OfflineRegionBounds

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

Readonlydocument

document: string

Stable document name: a descriptor id, landing-page, collections, and so on.

Optional Readonlyexpect

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 Readonlyquery

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.

Optional Readonlysignal

signal?: AbortSignal

Optional ReadonlystaleAfterMs

staleAfterMs?: number

Readonlystore

store: OfflineRegionStore

Settings

Member Visibility

On This Page

Properties