API reference / @evolu/common / WebSocket / WebSocket
Interface: WebSocket
Defined in: packages/common/src/WebSocket.ts:14
WebSocket with auto-reconnect and offline support.
Extends
Disposable
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
getReadyState | readonly | () => WebSocketReadyState | - | packages/common/src/WebSocket.ts:23 |
isOpen | readonly | () => boolean | Returns true if the WebSocket is open and ready to send data. | packages/common/src/WebSocket.ts:26 |
send | public | (data) => Result<void, WebSocketSendError> | Send data through the WebSocket connection. Returns Result with an error if the data couldn't be sent. | packages/common/src/WebSocket.ts:19 |
Methods
[dispose]()
Defined in: node_modules/typescript/lib/lib.esnext.disposable.d.ts:36
Returns
void
Inherited from
Disposable.[dispose]
Defined in: node_modules/@types/node/compatibility/disposable.d.ts:9
Returns
void
Inherited from
Disposable.[dispose]