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.

interface WebSocket extends EventTarget {

binaryType: BinaryType;

readonly bufferedAmount: number;

readonly CLOSED: number;

readonly CLOSING: number;

readonly CONNECTING: number;

readonly extensions: string;

onclose: ((this: WebSocket, ev: CloseEvent) => any) | null;

onerror: ((this: WebSocket, ev: Event) => any) | null;

onmessage: ((this: WebSocket, ev: MessageEvent) => any) | null;

onopen: ((this: WebSocket, ev: Event) => any) | null;

readonly OPEN: number;

readonly protocol: string;

readonly readyState: number;

readonly url: string;

addEventListener<K extends keyof WebSocketEventMap>(

type: K,

listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any,

options?: boolean | AddEventListenerOptions,

): void;

addEventListener(

type: string,

listener: EventListenerOrEventListenerObject,

options?: boolean | AddEventListenerOptions,

): void;

close(code?: number, reason?: string): void;

removeEventListener<K extends keyof WebSocketEventMap>(

type: K,

listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any,

options?: boolean | EventListenerOptions,

): void;

removeEventListener(

type: string,

listener: EventListenerOrEventListenerObject,

options?: boolean | EventListenerOptions,

): void;

send(data:

| string

| ArrayBufferLike

| Blob

| ArrayBufferView

): void;

}

var WebSocket: {

prototype: WebSocket;

readonly CLOSED: number;

readonly CLOSING: number;

readonly CONNECTING: number;

readonly OPEN: number;

new (url: string | URL, protocols?: string | string[]): WebSocket;

};

§Extends

EventTarget

[src]

§Properties

binaryType: BinaryType

[src]

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: number

[src]

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 CLOSED: number

[src]

readonly CLOSING: number

[src]

readonly CONNECTING: number

[src]

readonly extensions: string

[src]

Returns the extensions selected by the server, if any.

onclose: ((this: WebSocket, ev: CloseEvent) => any) | null

[src]

onerror: ((this: WebSocket, ev: Event) => any) | null

[src]

onmessage: ((this: WebSocket, ev: MessageEvent) => any) | null

[src]

onopen: ((this: WebSocket, ev: Event) => any) | null

[src]

readonly OPEN: number

[src]

readonly protocol: string

[src]

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: number

[src]

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

readonly url: string

[src]

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

§Methods

addEventListener<K extends keyof WebSocketEventMap>(

type: K,

listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any,

options?: boolean | AddEventListenerOptions,

): void

[src]

addEventListener(

type: string,

listener: EventListenerOrEventListenerObject,

options?: boolean | AddEventListenerOptions,

): void

[src]

close(code?: number, reason?: string): void

[src]

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

removeEventListener<K extends keyof WebSocketEventMap>(

type: K,

listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any,

options?: boolean | EventListenerOptions,

): void

[src]

removeEventListener(

type: string,

listener: EventListenerOrEventListenerObject,

options?: boolean | EventListenerOptions,

): void

[src]