Interface: SyncConfig<T, TKey>#

Defined in: packages/db/src/types.ts:365

Type Parameters#

T#

T extends object = Record<string, unknown>

TKey#

TKey extends string | number = string | number

Properties#

exportSyncMeta()?#

optional exportSyncMeta: () => unknown;

Defined in: packages/db/src/types.ts:409

Export adapter-specific metadata that lets hydration/persistence resume sync. The payload shape is owned by the adapter.

Returns#

unknown

getSyncMetadata()?#

optional getSyncMetadata: () => Record<string, unknown>;

Defined in: packages/db/src/types.ts:403

Get the sync metadata for insert operations

Returns#

Record<string, unknown>

Record containing relation information

importSyncMeta()?#

optional importSyncMeta: (meta) => void;

Defined in: packages/db/src/types.ts:414

Import adapter-specific metadata produced by exportSyncMeta.

Parameters#

meta#

unknown

Returns#

void

mergeSyncMeta()?#

optional mergeSyncMeta: (current, incoming) => unknown;

Defined in: packages/db/src/types.ts:419

Merge two adapter-specific metadata payloads during hydration.

Parameters#

current#

unknown

incoming#

unknown

Returns#

unknown

rowUpdateMode?#

optional rowUpdateMode: "full" | "partial";

Defined in: packages/db/src/types.ts:428

The row update mode used to sync to the collection.

Default#

partial

Description#

• partial: Updates contain only the changes to the row.
• full: Updates contain the entire row.

sync()#

sync: (params) => 
  | void
  | CleanupFn
  | SyncConfigRes;

Defined in: packages/db/src/types.ts:369

Parameters#

params#

begin#

(options?) => void

Begin a new sync transaction.

collection#

Collection<T, TKey, any, any, any>

commit#

(signal?) => SyncAppliedReceipt

Commit the active sync transaction in FIFO order. Returns true when the writes and events are already visible. Otherwise returns a receipt that resolves after they become visible. If collection cleanup or an optional request abort abandons the transaction first, the receipt rejects with an error named AbortError. Pass a signal only for request-scoped work that must not publish after cancellation. Aborting after application has no effect.

markError#

(error?) => void

Signal that initial sync failed before producing a usable snapshot. When supplied, error is preserved as the rejection reason from preload().

markReady#

() => void

Signal that a usable initial or recovered snapshot is available.

metadata?#

SyncMetadataApi<TKey>

truncate#

() => void

write#

(message) => void

Returns#

| void | CleanupFn | SyncConfigRes