EagerSyncHooks

type EagerSyncHooks = object;

Defined in: definitions.ts:173

Eager sync mode hooks. Called once when the collection sync starts and stops.

Properties#

onLoad()?#

optional onLoad: () => CleanupFn | void | Promise<CleanupFn | void>;

Defined in: definitions.ts:181

Called when the collection sync starts. Use this to set up external data sources (e.g. subscribing to a sync stream).

Returns#

CleanupFn | void | Promise<CleanupFn | void>

A cleanup function that is called when the collection sync is cleaned up.

onLoadSubset?#

optional onLoadSubset: never;

Defined in: definitions.ts:182

syncMode?#

optional syncMode: "eager";

Defined in: definitions.ts:174