Interface LabGuiWebsocketOptions

Hierarchy

Properties

automaticOpen? binaryType? debug? maxReconnectAttempts? maxReconnectInterval? protocols? reconnectDecay? reconnectInterval? timeoutInterval? websocketClass?

Properties

Optional automaticOpen

automaticOpen?: boolean

Whether or not the websocket should attempt to connect immediately upon instantiation.

Optional binaryType

binaryType?: "blob" | "arraybuffer"

The binary type, possible values 'blob' or 'arraybuffer', default 'blob'.

Optional debug

debug?: boolean

Whether this instance should log debug messages.

Optional maxReconnectAttempts

maxReconnectAttempts?: null | number

The maximum number of reconnection attempts to make. Unlimited if null.

Optional maxReconnectInterval

maxReconnectInterval?: number

The maximum number of milliseconds to delay a reconnection attempt.

Optional protocols

protocols?: string[]

Protocols to be used

Optional reconnectDecay

reconnectDecay?: number

The rate of increase of the reconnect delay. Allows reconnect attempts to back off when problems persist.

Optional reconnectInterval

reconnectInterval?: number

The number of milliseconds to delay before attempting to reconnect.

Optional timeoutInterval

timeoutInterval?: number

The maximum time in milliseconds to wait for a connection to succeed before closing and retrying.

Optional websocketClass

websocketClass?: { CLOSED: number; CLOSING: number; CONNECTING: number; OPEN: number; prototype: WebSocket }

WebSocket Class to create the WebSocket, this is mainly to mock it for testing

Type declaration

  • Readonly CLOSED: number
  • Readonly CLOSING: number
  • Readonly CONNECTING: number
  • Readonly OPEN: number
  • prototype: WebSocket

Settings

Member Visibility

Theme

Generated using TypeDoc