Interface WSSocket

addEventListener

• addEventListener<K extends keyof WSEventMap>(
      type: K,
      listener: (ev: WSEventMap[K]) => any,
      options?: boolean | AddEventListenerOptions,
  ): void

  Adds an event listener to the WebSocket

  Type Parameters

  • K extends keyof WSEventMap

  Parameters

  • type: K

    An event type

  • listener: (ev: WSEventMap[K]) => any

    The callback

  • Optionaloptions: boolean | AddEventListenerOptions

    Additional native event listener options

  Returns void

  See

  WSEventMap

• addEventListener(
      type: string,
      listener: EventListenerOrEventListenerObject,
      options?: boolean | AddEventListenerOptions,
  ): void

  Adds an event listener to the WebSocket

  Parameters

  • type: string

    An event type

  • listener: EventListenerOrEventListenerObject

    The callback

  • Optionaloptions: boolean | AddEventListenerOptions

    Additional native event listener options

  Returns void

  See

  WSEventMap

close

• close(code?: number): void

  Closes the WebSocket from the client

  Parameters

  • Optionalcode: number

    An optional code to give the server

  Returns void

removeEventListener

• removeEventListener<K extends keyof WSEventMap>(
      type: K,
      listener: (ev: WSEventMap[K]) => any,
      options?: boolean | EventListenerOptions,
  ): void

  Removes an event listener from the WebSocket

  Type Parameters

  • K extends keyof WSEventMap

  Parameters

  • type: K

    The original event type

  • listener: (ev: WSEventMap[K]) => any

    The original callback passed; MUST be a reference to the original function, NOT the same code copy-pasted

  • Optionaloptions: boolean | EventListenerOptions

    Additional native event listener options

  Returns void

  See

  WSEventMap

• removeEventListener(
      type: string,
      listener: EventListenerOrEventListenerObject,
      options?: boolean | EventListenerOptions,
  ): void

  Removes an event listener from the WebSocket

  Parameters

  • type: string

    The original event type

  • listener: EventListenerOrEventListenerObject

    The original callback passed; MUST be a reference to the original function, NOT the same code copy-pasted

  • Optionaloptions: boolean | EventListenerOptions

    Additional native event listener options

  Returns void

  See

  WSEventMap

send

• send(data: string | Uint8Array<ArrayBuffer>): void

  Sends data to the WebSocket server

  Parameters

  • data: string | Uint8Array<ArrayBuffer>

    The data

  Returns void

binaryType

readyState