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.

MDN Reference

Hierarchy

Properties

CLOSED: 3
CLOSING: 2
CONNECTING: 0
OPEN: 1
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".

MDN Reference

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

MDN Reference

extensions: string

Returns the extensions selected by the server, if any.

MDN Reference

onclose: ((this, ev) => any)

Type declaration

onerror: ((this, ev) => any)

Type declaration

onmessage: ((this, ev) => any)

Type declaration

onopen: ((this, ev) => any)

Type declaration

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.

MDN Reference

readyState: number

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

MDN Reference

url: string

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

MDN Reference

Methods

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

    MDN Reference

    Parameters

    • Optional code: number
    • Optional reason: string

    Returns void

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

    MDN Reference

    Parameters

    Returns boolean