TLSyncStorage

Pluggable synchronous transactional storage layer for TLSyncRoom. Provides methods for managing documents, tombstones, and clocks within transactions.

interface TLSyncStorage<R extends UnknownRecord> {}

Methods

The same entries for the given ids, for callers that need a handful of records rather than the whole (parsed) lane. Ids with no object-lane record are omitted — document-lane ids included — and duplicates yield one entry.

Parameters

Iterable<string>;

Returns

RoomSnapshot["documents"];

A snapshot of the object-store lane (see objectTypes on the storage), for hosts that persist object-lane records separately from the document. Same entry shape as RoomSnapshot['documents'] so a lane can be persisted and re-seeded via a merged snapshot.

A snapshot of the document lane only — never contains object-store lane records.

Parameters

(
  arg: TLSyncStorageOnChangeCallbackProps,
) => unknown;

Returns

() => void;

Parameters

TLSyncStorageTransactionCallback<R, T>;

TLSyncStorageTransactionOptions;

Returns

TLSyncStorageTransactionResult<T, R>;