Interface: WebSocketClientOptions

Defined in: packages/client/src/links/wsLink/wsClient/options.ts:4

Extends

• UrlOptionsWithConnectionParams

Properties

connectionParams?

optional connectionParams: CallbackOrValue<null | Dict<string>>

Defined in: packages/client/src/links/internals/urlWithConnectionParams.ts:32

Connection params that are available in createContext()

• For wsLink/wsClient, these are sent as the first message
• For httpSubscriptionLink, these are serialized as part of the URL under the connectionParams query

Inherited from

UrlOptionsWithConnectionParams.connectionParams

---

experimental_encoder?

optional experimental_encoder: Encoder

Defined in: packages/client/src/links/wsLink/wsClient/options.ts:64

Custom encoder for wire encoding (e.g. custom binary formats)

Default

ts
jsonEncoder

ts
jsonEncoder

---

keepAlive?

optional keepAlive: object

Defined in: packages/client/src/links/wsLink/wsClient/options.ts:44

Send ping messages to the server and kill the connection if no pong message is returned

enabled

enabled: boolean

Default

ts
false

ts
false

intervalMs?

optional intervalMs: number

Send a ping message every this many milliseconds

Default

ts
5_000

ts
5_000

pongTimeoutMs?

optional pongTimeoutMs: number

Close the WebSocket after this many milliseconds if the server does not respond

Default

ts
1_000

ts
1_000

---

lazy?

optional lazy: object

Defined in: packages/client/src/links/wsLink/wsClient/options.ts:29

Lazy mode will close the WebSocket automatically after a period of inactivity (no messages sent or received and no pending requests)

closeMs

closeMs: number

Close the WebSocket after this many milliseconds

Default

ts
0

ts
0

enabled

enabled: boolean

Enable lazy mode

Default

ts
false

ts
false

---

onClose()?

optional onClose: (cause?) => void

Defined in: packages/client/src/links/wsLink/wsClient/options.ts:25

Triggered when a WebSocket connection is closed

Parameters

Parameter	Type
cause?	{ code: number; }
cause.code?	number

Returns

void

---

onError()?

optional onError: (evt?) => void

Defined in: packages/client/src/links/wsLink/wsClient/options.ts:21

Triggered when a WebSocket connection encounters an error

Parameters

Parameter	Type
evt?	Event

Returns

void

---

onOpen()?

optional onOpen: () => void

Defined in: packages/client/src/links/wsLink/wsClient/options.ts:17

Triggered when a WebSocket connection is established

Returns

void

---

retryDelayMs()?

optional retryDelayMs: (attemptIndex) => number

Defined in: packages/client/src/links/wsLink/wsClient/options.ts:13

The number of milliseconds before a reconnect is attempted.

Parameters

Parameter	Type
attemptIndex	number

Returns

number

Default

exponentialBackoff

---

url

url: CallbackOrValue<string>

Defined in: packages/client/src/links/internals/urlWithConnectionParams.ts:25

The URL to connect to (can be a function that returns a URL)

Inherited from

UrlOptionsWithConnectionParams.url

---

WebSocket()?

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

Defined in: packages/client/src/links/wsLink/wsClient/options.ts:8

Ponyfill which WebSocket implementation to use

Parameters

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

Returns

WebSocket

CLOSED

readonly CLOSED: 3

CLOSING

readonly CLOSING: 2

CONNECTING

readonly CONNECTING: 0

OPEN

readonly OPEN: 1

prototype

prototype: WebSocket