Type Alias WsSocketFactory

WsSocketFactory: (
u: string,
opts: ConnectionOptions,
) => Promise<{ encrypted: boolean; socket: WebSocket }>

WsSocketFactory is a factory that returns a WebSocket and a boolean indicating if the connection is encrypted. Client code is responsible for creating a W3C WebSocket compliant transport.

Type declaration

- (
  u: string,
  opts: ConnectionOptions,
  ): Promise<{ encrypted: boolean; socket: WebSocket }>
- Parameters
  - u: string
    the url to connect to
  - opts: ConnectionOptions
    the connection options
  Returns Promise<{ encrypted: boolean; socket: WebSocket }>
  a promise that resolves to a WebSocket and a boolean indicating if the connection is encrypted

Type Alias WsSocketFactory

Type declaration

Parameters

Returns Promise<{ encrypted: boolean; socket: WebSocket }>

Settings