Skip to main content

Type Alias: SyncState

type SyncState = "stopped" | "starting" | "active" | "idle" | "error" | "denied";

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

Where a stack's replication currently stands.

  • "stopped" - never started, or cancelled.
  • "starting" - resolving the remote and running the schema gate.
  • "active" - documents are moving.
  • "idle" - a replication cycle finished with nothing left to send; this is the state that carries a meaningful lastConvergedAt.
  • "error" - the last cycle failed. With retry: true replication keeps trying and will return to "active" on its own.
  • "denied" - the remote refused a write (permissions), which retrying will not fix.