Chartbreaker
    Preparing search index...

    Interface WebSocket_2

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

    interface WebSocket_2 {
        binaryType: BinaryType_2;
        bufferedAmount: number;
        CLOSED: number;
        CLOSING: number;
        CONNECTING: number;
        extensions: string;
        onclose: null | ((this: WebSocket_2, ev: CloseEvent_2) => any);
        onerror: null | ((this: WebSocket_2, ev: Event_2) => any);
        onmessage: null | ((this: WebSocket_2, ev: MessageEvent_2) => any);
        onopen: null | ((this: WebSocket_2, ev: Event_2) => any);
        OPEN: number;
        protocol: string;
        readyState: number;
        url: string;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject_2,
            options?: boolean | AddEventListenerOptions_2,
        ): void;
        close(code?: number, reason?: string): void;
        removeEventListener<K extends keyof WebSocketEventMap_2>(
            type: K,
            listener: (this: WebSocket_2, ev: WebSocketEventMap_2[K]) => any,
            options?: boolean | EventListenerOptions_2,
        ): void;
        send(
            data: string | ArrayBufferLike | ArrayBufferView<ArrayBufferLike>,
        ): void;
    }
    Index

    Properties

    binaryType bufferedAmount CLOSED CLOSING CONNECTING extensions onclose onerror onmessage onopen OPEN protocol readyState url

    Methods

    addEventListener close removeEventListener send

    Properties

    binaryType: BinaryType_2

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

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

    CLOSED: number
    CLOSING: number
    CONNECTING: number
    extensions: string

    Returns the extensions selected by the server, if any.

    onclose: null | ((this: WebSocket_2, ev: CloseEvent_2) => any)
    onerror: null | ((this: WebSocket_2, ev: Event_2) => any)
    onmessage: null | ((this: WebSocket_2, ev: MessageEvent_2) => any)
    onopen: null | ((this: WebSocket_2, ev: Event_2) => any)
    OPEN: number
    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.

    readyState: number

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

    url: string

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

    Methods

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

      Parameters

      • Optionalcode: number
      • Optionalreason: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods