Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebSocket

Package version

Provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.

Hierarchy

Index

Properties

Methods

Properties

CLOSED

CLOSED: number

CLOSING

CLOSING: number

CONNECTING

CONNECTING: number

EventTarget

EventTarget: { constructor: any; prototype: EventTarget }

Type declaration

  • constructor: function

    • Returns EventTarget

  • prototype: EventTarget

OPEN

OPEN: number

binaryType

binaryType: BinaryType

bufferedAmount

bufferedAmount: number

extensions

extensions: string

onclose

onclose: ((this: WebSocket, ev: CloseEvent) => any) | null

onerror

onerror: ((this: WebSocket, ev: Event) => any) | null

onmessage

onmessage: ((this: WebSocket, ev: MessageEvent) => any) | null

onopen

onopen: ((this: WebSocket, ev: Event) => any) | null

protocol

protocol: string

readyState

readyState: number

url

url: string

Methods

addEventListener

close

  • close(code?: undefined | number, reason?: undefined | string): void

  • Parameters

    • Optional code: undefined | number
    • Optional reason: undefined | string

    Returns void

dispatchEvent

  • dispatchEvent(event: Event): boolean

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

removeEventListener

send

  • send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void

  • Parameters

    • data: string | ArrayBufferLike | Blob | ArrayBufferView

    Returns void

Generated using TypeDoc