API reference › @evolu/common › local‑first/Relay

Relay server for data synchronization.

Functions

FunctionDescription
createRelaySqliteStorage-
createRelayStorageTables-

Interfaces

InterfaceDescription
RelaySync and backup relay for Evolu clients.
RelayConfigConfiguration of a relay. A relay should also send the heartbeats that OwnerWebSocketTransport describes.
RelaySqliteStorageA RelayStorage on SQLite.
RelayStorageThe storage a relay syncs with. Unlike a client's Storage, it checks the OwnerWriteKey of every write.
RelayStorageDep-
StorageWriteKeyErrorError when a write presents another write key than the owner's.

Type Aliases

Type AliasDescription
RelayStorageWriteMessagesErrorReasons why RelayStorage.writeMessages stored none of a batch.