lspeasy / core/src / WebSocketTransportOptions
Interface: WebSocketTransportOptions
Defined in: packages/core/src/transport/websocket.ts:43
Options for configuring a WebSocketTransport.
Remarks
Provide either url (client mode — the transport opens the connection) or socket (server mode — the transport wraps an already-accepted WebSocket). Providing both or neither throws at construction time.
Config
Properties
| Property | Type | Default value | Description | Defined in |
|---|---|---|---|---|
enableReconnect? | boolean | false | Enable automatic reconnection on unexpected disconnect (client mode only). | packages/core/src/transport/websocket.ts:60 |
maxReconnectAttempts? | number | 5 | Maximum number of reconnection attempts before giving up. | packages/core/src/transport/websocket.ts:66 |
maxReconnectDelay? | number | 30000 | Maximum delay between reconnection attempts in milliseconds. | packages/core/src/transport/websocket.ts:78 |
reconnectBackoffMultiplier? | number | 2 | Multiplier for exponential back-off between reconnection attempts. | packages/core/src/transport/websocket.ts:84 |
reconnectDelay? | number | 1000 | Initial delay between reconnection attempts in milliseconds. | packages/core/src/transport/websocket.ts:72 |
socket? | WebSocketLike | undefined | Existing WebSocket instance for server mode. Mutually exclusive with url. | packages/core/src/transport/websocket.ts:54 |
url? | string | undefined | WebSocket URL for client mode (e.g., 'ws://localhost:3000'). Mutually exclusive with socket. | packages/core/src/transport/websocket.ts:48 |