SyncConfig

Interface: SyncConfig<T, TKey>

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

Type Parameters

T extends object = Record<string, unknown>

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:216

Get the sync metadata for insert operations

Returns

Record<string, unknown>

Record containing relation information


rowUpdateMode?

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

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

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;
sync: (params) => void;

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

Parameters

params
begin

() => void

collection

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

commit

() => void

markReady

() => void

write

(message) => void

Returns

void

Our Partners
Electric
Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.