Skip to main content
Version: 11.x

Function: createWSClient()

createWSClient(opts): object

Parameters

ParameterType
optsWebSocketClientOptions

Returns

close

close: () => void

Returns

void

connection

readonly connection: {id: number;} & {state: "open"; ws: WebSocket;} | {state: "closed"; ws: WebSocket;} | {state: "connecting"; ws: WebSocket;} | null

reconnect

reconnect: () => void

Reconnect to the WebSocket server

Returns

void

request

request: (opts) => UnsubscribeFn

Parameters

ParameterType
optsobject
opts.callbacksWSCallbackObserver< AnyRouter, unknown >
opts.lastEventIdstring | undefined
opts.opOperation

Returns

UnsubscribeFn

Source

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


Generated using TypeDoc and typedoc-plugin-markdown