Toolmark

Appearance

toolmark-monorepo / @toolmark/core/bridge/websocket / WebSocketTransportOptions

Interface: WebSocketTransportOptions ​

Defined in: packages/core/src/bridge/websocket.ts:34

Options for websocketTransport.

Properties ​

maxDelayMs? ​

optional maxDelayMs?: number

Defined in: packages/core/src/bridge/websocket.ts:40

Reconnect backoff cap in ms (default 30000; the first delay is 500, doubling).

onOpen? ​

optional onOpen?: (socket, io) => void | Promise<void>

Defined in: packages/core/src/bridge/websocket.ts:48

Runs (and is awaited) on every (re)connect before buffered bridge messages flush, e.g. for a handshake. Frames arriving meanwhile go to io.receive, never to the bridge; frames onOpen did not read are discarded when it resolves. A rejection stops the transport.

Parameters ​

socket ​

WebSocket

io ​

WebSocketOpenIo

Returns ​

void | Promise<void>

onStatus? ​

optional onStatus?: (status) => void

Defined in: packages/core/src/bridge/websocket.ts:50

Connection status callback.

Parameters ​

status ​

WebSocketTransportStatus

Returns ​

void

protocols? ​

optional protocols?: string | string[]

Defined in: packages/core/src/bridge/websocket.ts:38

WebSocket sub-protocols.

terminalCloseCodes? ​

optional terminalCloseCodes?: number[]

Defined in: packages/core/src/bridge/websocket.ts:42

Close codes that stop the transport instead of reconnecting (default []).

url ​

url: string

Defined in: packages/core/src/bridge/websocket.ts:36

WebSocket URL (wss:// in production).