SyncPersistenceCapabilityV1 | TanStack DB English

type SyncPersistenceCapabilityV1<TKey> = object;

Internal

Unstable cross-package protocol for persistence-aware adapters.

Type Parameters

TKey extends string | number = string | number

readonly hydrateBaseline: () => Promise<void>;

Promise<void>

readonly protocol: "@tanstack/db/sync-persistence";

readonly reserveCommitTurn: () => void;

Reserve the open sync transaction's FIFO turn, so a subset hydration that starts before it commits waits for that commit.

void

readonly resumeSnapshot: object;

readonly certify: () => Promise<void>;

Promise<void>

readonly expectCurrentCommit: () => void;

void

readonly getKeySetEvidence: () => 
  | SyncPersistenceKeySetEvidence
  | undefined;

readonly scanPersistedRows: (options?) => Promise<SyncPersistenceScannedRow<TKey>[]>;

readonly version: 1;