Class WsTransport

Readonlyrx

mtu

• get mtu(): number

• Report MTU as Infinity.

  Returns number

  See

  https://stackoverflow.com/a/20658569

close

• close(): void

• Returns void

reopen

• reopen(): Promise<WsTransport>

• Reopen the transport by connecting again with the same options.

  Returns Promise<WsTransport>

tx

• tx(iterable: TxIterable): Promise<void>

• Function to accept outgoing packet stream.

  Parameters

  • iterable: TxIterable

    Iterable of outgoing packets sent through the transport. Size of each packet cannot exceed .mtu.

  Returns Promise<void>

  Promise that resolves when iterable is exhausted or rejects upon error.

Staticconnect

• connect(
      uri: string | WebSocket | WebSocket,
      opts?: WsTransport.Options,
  ): Promise<WsTransport>

• Create a transport by connecting to WebSocket server or from existing WebSocket instance.

  Parameters

  • uri: string | WebSocket | WebSocket

    Server URI or existing WebSocket instance.
  • opts: WsTransport.Options = {}

  Returns Promise<WsTransport>

  See

  WsTransport.createFace