Skip to main content

Interface: SyncStatus

Defined in: packages/client/src/core/sync/index.ts:115

A point-in-time reading of one stack's replication.

Properties

PropertyTypeDescriptionDefined in
directionSyncDirectionDirection this handle was started with.packages/client/src/core/sync/index.ts:121
lastActiveAtnumberWhen documents last moved, in either direction.packages/client/src/core/sync/index.ts:131
lastConvergedAtnumberWhen the replica last converged - a cycle completed with nothing left to send. null until the first one. This is the value a UI should render as "last synced", not lastActiveAt.packages/client/src/core/sync/index.ts:129
lastErrorobjectThe last failure seen, kept even after replication recovers.packages/client/src/core/sync/index.ts:133
lastError.messagestring-packages/client/src/core/sync/index.ts:133
lastError.name?string-packages/client/src/core/sync/index.ts:133
lastError.status?number-packages/client/src/core/sync/index.ts:133
livebooleanWhether the handle is following changes or ran once.packages/client/src/core/sync/index.ts:123
pullednumberDocuments written locally since this handle started.packages/client/src/core/sync/index.ts:137
pushednumberDocuments written to the remote since this handle started.packages/client/src/core/sync/index.ts:135
stackstringThe stack this status belongs to.packages/client/src/core/sync/index.ts:117
stateSyncStateSee SyncState.packages/client/src/core/sync/index.ts:119