Hierarchy (view full)

Constructors

Properties

extensions: string

Returns the extensions selected by the server, if any.

MDN Reference

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

CLOSED: number
CLOSING: number
CONNECTING: number
OPEN: number
READY_STATE_CLOSED: number
READY_STATE_CLOSING: number
READY_STATE_CONNECTING: number
READY_STATE_OPEN: number

Methods

  • Returns void

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    MDN Reference

    Type Parameters

    Returns void

  • 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

  • Returns any

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

    MDN Reference

    Parameters

    • message: string | ArrayBuffer | ArrayBufferView

    Returns void

  • Parameters

    • attachment: any

    Returns void