SyncConfig

Interface: SyncConfig<T, TKey>

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

Type Parameters

T

T extends object = Record<string, unknown>

TKey

TKey extends string | number = string | number

Properties

getSyncMetadata()?

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

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

Get the sync metadata for insert operations

Returns

Record<string, unknown>

Record containing relation information


rowUpdateMode?

ts
optional rowUpdateMode: "full" | "partial";
optional rowUpdateMode: "full" | "partial";

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

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()

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

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

Parameters

params
begin

() => void

collection

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

commit

() => void

markReady

() => void

truncate

() => void

write

(message) => void

Returns

| void | CleanupFn | SyncConfigRes