Class WebSocketClient

A WebSocket client.

Hierarchy

  • WebSocketClient

Constructors

Properties

Accessors

Methods

Constructors

  • Parameters

    • path: string
    • parse: ((data: any) => any) = ...
        • (data: any): any
        • Parameters

          • data: any

          Returns any

    • serialize: ((data: any) => any) = ...
        • (data: any): any
        • Parameters

          • data: any

          Returns any

    • onOpen: ((client: WebSocketClient) => void) = ...
    • Optional headers: { [key: string]: string }
      • [key: string]: string

    Returns WebSocketClient

Properties

_connected: boolean
_messages: any[] = []
_parse: ((data: any) => any)

Type declaration

    • (data: any): any
    • Parameters

      • data: any

      Returns any

_raw: WebSocket
_serialize: ((data: any) => any)

Type declaration

    • (data: any): any
    • Parameters

      • data: any

      Returns any

Accessors

  • get connected(): boolean
  • Whether the WebSocket is connected or not.

    Returns boolean

  • get message(): Promise<any>
  • The newest or next WebSocket message.

    Returns Promise<any>

Methods

  • Close the websocket connection.

    Returns Promise<void>

  • Send a ping frame to the server. Returns a promise that resolves once a pong response was received.

    Parameters

    • Optional data: any

      The data to send along with the ping frame.

    • parse: boolean = false

      Whether to parse and serialize the sent and received data. Defaults to false.

    Returns Promise<any>

  • Send data through the websocket.

    Parameters

    • data: any

      The data to send.

    Returns Promise<void>

Generated using TypeDoc