Interface WsConfig

Config for a WebSocket connection to Chronik.

Hierarchy

WsConfig

Index

Properties

autoReconnect

Methods

Properties

Optional autoReconnect

autoReconnect?: boolean

Whether to automatically reconnect on disconnect, default true.

Methods

Optional onConnect

onConnect(e: Event): void

- Defined in index.ts:209
Fired when a connection has been (re)established.

Parameters
- e: Event
Returns void

Optional onEnd

onEnd(e: Event): void

- Defined in index.ts:220
Fired after a connection has been manually closed, or if autoReconnect is false, if the WebSocket disconnects for any reason.

Parameters
- e: Event
Returns void

Optional onError

onError(e: ErrorEvent): void

- Defined in index.ts:216
Fired when an error with the WebSocket occurs.

Parameters
- e: ErrorEvent
Returns void

Optional onMessage

onMessage(msg: SubscribeMsg): void

- Defined in index.ts:206
Fired when a message is sent from the WebSocket.

Parameters
- msg: SubscribeMsg
Returns void

Optional onReconnect

onReconnect(e: Event): void

- Defined in index.ts:213
Fired after a connection has been unexpectedly closed, and before a reconnection attempt is made. Only fired if autoReconnect is true.

Parameters
- e: Event
Returns void

Generated using TypeDoc