Interface

WebSocket

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.

View Source js/lib.dom.d.ts, line 6932

Members

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".

View Source js/lib.dom.d.ts, line 6935

number

# bufferedAmount

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.)

View Source js/lib.dom.d.ts, line 6942

void

# close

Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

View Source js/lib.dom.d.ts, line 6969

string

# extensions

Returns the extensions selected by the server, if any.

View Source js/lib.dom.d.ts, line 6949

string

# protocol

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.

View Source js/lib.dom.d.ts, line 6954

number

# readyState

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

View Source js/lib.dom.d.ts, line 6959

void

# send

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

View Source js/lib.dom.d.ts, line 6974

string

# url

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

View Source js/lib.dom.d.ts, line 6964