API reference › @evolu/common › local‑first/Relay
Relay server for data synchronization.
Functions
| Function | Description |
|---|---|
| createRelaySqliteStorage | - |
| createRelayStorageTables | - |
Interfaces
| Interface | Description |
|---|---|
| Relay | Sync and backup relay for Evolu clients. |
| RelayConfig | Configuration of a relay. A relay should also send the heartbeats that OwnerWebSocketTransport describes. |
| RelaySqliteStorage | A RelayStorage on SQLite. |
| RelayStorage | The storage a relay syncs with. Unlike a client's Storage, it checks the OwnerWriteKey of every write. |
| RelayStorageDep | - |
| StorageWriteKeyError | Error when a write presents another write key than the owner's. |
Type Aliases
| Type Alias | Description |
|---|---|
| RelayStorageWriteMessagesError | Reasons why RelayStorage.writeMessages stored none of a batch. |