WebSocketConfig
Defined in: packages/core/src/data/streaming/websocket-connection.ts:16
Configuration for WebSocket connections.
Remarks
Section titled “Remarks”WebSocket provides full-duplex communication over a single TCP connection, enabling bidirectional data flow between client and server.
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
protocols? | string | string[] | WebSocket sub-protocols to use Remarks Sub-protocols allow the client and server to agree on a specific protocol on top of WebSocket. Can be a single string or array of strings. Example protocols: 'json' protocols: ['json', 'msgpack'] | - | packages/core/src/data/streaming/websocket-connection.ts:30 |
reconnect? | boolean | Enable automatic reconnection on disconnect (default: true) | ConnectionConfig.reconnect | packages/core/src/data/streaming/base-connection.ts:68 |
reconnectConfig? | Partial<RetryConfig> | Reconnection retry configuration | ConnectionConfig.reconnectConfig | packages/core/src/data/streaming/base-connection.ts:71 |
url | string | Connection URL | ConnectionConfig.url | packages/core/src/data/streaming/base-connection.ts:65 |