@muspellheim/shared
    Preparing search index...

    Class WebSocketClient

    A client for the WebSocket protocol.

    Hierarchy

    • EventTarget
      • WebSocketClient

    Implements

    Index

    Accessors

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • Close the connection.

      If a code is provided, also a reason should be provided.

      Parameters

      • Optionalcode: number

        An optional code.

      • Optionalreason: string

        An optional reason.

      Returns Promise<void>

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      Returns boolean

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Send a message to the server.

      This is an optional method for streams with bidirectional communication.

      Parameters

      • message: string | ArrayBuffer | Blob | ArrayBufferView<ArrayBufferLike>

        The message to send.

      Returns Promise<void>

    • Simulate a close event.

      Parameters

      • Optionalcode: number

        An optional code.

      • Optionalreason: string

        An optional reason.

      Returns void

    • Simulate a message event from the server.

      Parameters

      • message: string | number | boolean | object | ArrayBuffer | Blob | null

        The message to receive.

      Returns void