Interface: WebSocketClientOptions

Properties

WebSocket

optional WebSocket: (url, protocols?) => WebSocket

Parameters

Parameter	Type
url	string | URL
protocols?	string | string[]

Returns

WebSocket

Type declaration

WebSocket.CLOSED

readonly CLOSED: 3

WebSocket.CLOSING

readonly CLOSING: 2

WebSocket.CONNECTING

readonly CONNECTING: 0

WebSocket.OPEN

readonly OPEN: 1

WebSocket.prototype

prototype: WebSocket

Source

packages/client/dist/links/wsLink.d.ts:11

---

onClose

optional onClose: (cause?) => void

Parameters

Parameter	Type
cause?	object
cause.code?	number

Returns

void

Source

packages/client/dist/links/wsLink.d.ts:14

---

onOpen

optional onOpen: () => void

Returns

void

Source

packages/client/dist/links/wsLink.d.ts:13

---

retryDelayMs

optional retryDelayMs: (attemptIndex) => number

Parameters

Parameter	Type
attemptIndex	number

Returns

number

Source

packages/client/dist/links/wsLink.d.ts:12

---

url

url: string | () => string

Source

packages/client/dist/links/wsLink.d.ts:10

---

Generated using TypeDoc and typedoc-plugin-markdown