API reference › @evolu/common › local‑first/Shared › SyncRouteError

type SyncRouteError =
  | Exclude<ProtocolError, ProtocolInvalidDataError>
  | (Omit<ProtocolInvalidDataError, "error"> & {
      error: UnknownError;
    })
  | StorageWriteMessagesError
  | (Omit<DecryptWithXChaCha20Poly1305Error, "error"> & {
      error: UnknownError;
    })
  | ProtocolChangeTooLargeError
  | Typed<"WriteFailed">
  | (Typed<"SyncFailed"> & {
      at: Millis;
    });

Defined in: packages/common/src/local-first/Shared.ts:801

A failure or a skipped change of a SyncRoute, with the time it arrived.

It is the error itself, so it carries its details, such as the expected and actual timestamps of a ProtocolTimestampMismatchError. A skipped message adds DecryptWithXChaCha20Poly1305Error and ProtocolChangeTooLargeError. An UnknownError means SQLite failed to store received messages, for example on a full disk. WriteFailed means a writeMessages call that threw, logged by the protocol, and SyncFailed means a logged failure while creating a round or reconciling ranges.

Type Declaration