WebSocketClientOptions

Properties

WebSocket?

Function

ts
(url: string | URL, protocols?: string | string[]) => WebSocket

ts
(url: string | URL, protocols?: string | string[]) => WebSocket

Type declaration

Signature

ts
new WebSocket(url: string | URL, protocols?: string | string[]): WebSocket;

ts
new WebSocket(url: string | URL, protocols?: string | string[]): WebSocket;

Parameters

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

Returns

WebSocket

Member	Type
CLOSED	number
CLOSING	number
CONNECTING	number
OPEN	number
prototype	WebSocket

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

onClose?

Function

Type declaration

Signature

ts
(cause?: object): void;

ts
(cause?: object): void;

Parameters

Name	Type
cause?	object
cause.code?	number

Returns

void

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

onOpen?

Function

Type declaration

Signature

ts
(): void;

ts
(): void;

Returns

void

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

retryDelayMs?

Function

Type declaration

Signature

ts
(attemptIndex: number): number;

ts
(attemptIndex: number): number;

Parameters

Name	Type
attemptIndex	number

Returns

number

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

url

string | () => string

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