API reference@melon-db/db-react
useSync
@melon-db/db-react — useSync
@melon-db/db-react API Reference
Function: useSync()
useSync():
object
Defined in: sync-hooks.ts:14
Runs sync against the configured backend and exposes reactive status.
Returns
object
| Name | Type | Defined in |
|---|---|---|
cancel() | () => void | sync-hooks.ts:16 |
error | SyncError | null | sync-hooks.ts:22 |
isPaused | boolean | sync-hooks.ts:20 |
isSyncing | boolean | sync-hooks.ts:19 |
lastPulledAt | number | null | sync-hooks.ts:18 |
retryCount | number | sync-hooks.ts:21 |
status | SyncStatus | sync-hooks.ts:17 |
sync() | (options?) => Promise<SynchronizeResult> | sync-hooks.ts:15 |