Open History to see the last commit
Interface: SyncConfig<T, TKey>#
Defined in: packages/db/src/types.ts:327
Type Parameters#
T#
T extends object = Record<string, unknown>
TKey#
TKey extends string | number = string | number
Properties#
getSyncMetadata()?#
optional getSyncMetadata: () => Record<string, unknown>;
Defined in: packages/db/src/types.ts:350
Get the sync metadata for insert operations
Returns#
Record<string, unknown>
Record containing relation information
rowUpdateMode?#
optional rowUpdateMode: "full" | "partial";
Defined in: packages/db/src/types.ts:359
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:331
Parameters#
params#
begin#
(options?) => void
Begin a new sync transaction.
collection#
Collection<T, TKey, any, any, any>
commit#
() => void
markReady#
() => void
metadata?#
SyncMetadataApi<TKey>
truncate#
() => void
write#
(message) => void
Returns#
| void
| CleanupFn
| SyncConfigRes