Interface: WebSocketClientOptions

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:39

Options for createWSClient.

See

https://trpc.io/docs/client/links/wsLink#wslink--createwsclient-options

Extends

• UrlOptionsWithConnectionParams

Properties

connectionParams?

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

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:30

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

See

https://trpc.io/docs/server/websockets#connectionParams

Inherited from

UrlOptionsWithConnectionParams.connectionParams

experimental_encoder?

optional experimental_encoder: Encoder

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:101

Encodes and decodes messages on the wire, for example as a binary format.

Default

jsonEncoder

keepAlive?

optional keepAlive: object

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:81

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

enabled

enabled: boolean

Default

false

intervalMs?

optional intervalMs: number

Send a ping message every this many milliseconds

Default

5_000

pongTimeoutMs?

optional pongTimeoutMs: number

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

Default

1_000

lazy?

optional lazy: object

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:66

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

0

enabled

enabled: boolean

Enable lazy mode

Default

false

onClose()?

optional onClose: (cause?) => void

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:60

Triggered when a WebSocket connection is closed

Parameters

Returns

void

onError()?

optional onError: (evt?) => void

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:56

Triggered when a WebSocket connection encounters an error

Parameters

Returns

void

onOpen()?

optional onOpen: () => void

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:52

Triggered when a WebSocket connection is established

Returns

void

retryDelayMs()?

optional retryDelayMs: (attemptIndex) => number

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:48

The number of milliseconds before a reconnect is attempted.

Parameters

Returns

number

Default

exponentialBackoff

url

url: CallbackOrValue<string>

Defined in: packages/client/dist/wsLink-Cjetil1Z.d.mts:23

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/dist/wsLink-Cjetil1Z.d.mts:43

The WebSocket class to use, for runtimes that don't have one.

Parameters

Returns

WebSocket