Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebSocket

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

Readonly CLOSED

CLOSED: number

Readonly CLOSING

CLOSING: number

Readonly CONNECTING

CONNECTING: number

EventTarget

EventTarget: { constructor: any; prototype: EventTarget }

Type declaration

Readonly OPEN

OPEN: number

binaryType

binaryType: BinaryType

Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:

Can be set, to change how binary data is returned. The default is "blob".

Readonly bufferedAmount

bufferedAmount: number

Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)

Readonly extensions

extensions: string

Returns the extensions selected by the server, if any.

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

Readonly protocol

protocol: string

Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

Readonly readyState

readyState: number

Returns the state of the WebSocket object's connection. It can have the values described below.

Readonly url

url: string

Returns the URL that was used to establish the WebSocket connection.

Methods

addEventListener

close

  • close(code?: number, reason?: string): void
  • Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

    Parameters

    • Optional code: number
    • Optional reason: 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

  • Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.

    Parameters

    Returns void

Generated using TypeDoc