API reference / @evolu/common / WebSocket
WebSocket
Websocket with auto-reconnect and offline support
Interfaces
| Interface | Description |
|---|---|
| CreateWebSocketDep | - |
| WebSocket | WebSocket with auto-reconnect and offline support. |
| WebSocketConnectError | An error that occurs when a connection cannot be established due to a network error. |
| WebSocketConnectionCloseError | - |
| WebSocketConnectionError | An error that occurs when a connection is closed due to an issue (e.g., failure to send some data). |
| WebSocketOptions | Options for creating WebSocket |
| WebSocketSendError | An error that occurs when trying to send data but WebSocket is not available or is in the CONNECTING state. |
Type Aliases
| Type Alias | Description |
|---|---|
| CreateWebSocket | - |
| WebSocketError | - |
| WebSocketReadyState | WebSocket connection states. |
| WebSocketRetryError | - |
Variables
| Variable | Description |
|---|---|
| createWebSocket | Create a new WebSocket. |