Available on client only

syncOne(basicFilter: EqualityFilter, options: SyncOptions, onChange: OnChangeOne, onError?: OnErrorHandler): Promise<SingleSyncHandles>

Parameters

• basicFilter required EqualityFilter

  Filter used for data synchronization, where all specified columns must match the given values.

  Columns are combined using an AND condition.

  Example: { department: 'd1', name: 'abc' } would match records where department is ‘d1’ AND name is ‘abc’.

• options required SyncOptions

• onChange required OnChangeOne

• onError optional OnErrorHandler

Return type

SingleSyncHandles

CRUD handles added if initialised with handlesOnData = true

• $get required () => Required<{ [K in keyof TD]: CollapseNumberIfStringPresent<TD[K]>; }> | undefined
• $find required (idObj: Partial<Required<{ [K in keyof TD]: CollapseNumberIfStringPresent<TD[K]>; }>>) => Required<{ [K in keyof TD]: CollapseNumberIfStringPresent<TD[K]>; }> | undefined
• $unsync required () => void
• $delete required () => void
• $update required <OPTS extends $UpdateOpts>(newData: OPTS extends { deepMerge: true; } ? DeepPartial<TD> : Partial<TD>, opts?: OPTS | undefined) => Promise<void>
• $cloneSync required CloneSync
• $cloneMultiSync required CloneMultiSync