WebSocket

Предоставляет API для создания и управления подключением WebSocket к серверу, а также для отправки и получения данных по этому подключению.

Если вы хотите создать сервер WebSocket, ознакомьтесь с Deno.upgradeWebSocket().

class WebSocket extends EventTarget {

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


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 | ErrorEvent) => 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;


static readonly CLOSED: number;


static readonly CLOSING: number;


static readonly CONNECTING: number;


static readonly OPEN: number;


}

Наследование

EventTarget

Конструкторы

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

Свойства

binaryType: BinaryType

Возвращает строку, указывающую, как двоичные данные из объекта WebSocket предоставляются скриптам:

Может быть установлено для изменения способа возврата двоичных данных. По умолчанию — "blob".

bufferedAmount: number

Возвращает количество байтов прикладных данных (текст UTF-8 и двоичные данные), которые были помещены в очередь с помощью send(), но ещё не были переданы в сеть.

Если соединение WebSocket закрыто, это значение будет увеличиваться с каждым вызовом метода send(). (Число не сбрасывается до нуля после закрытия соединения.)

CLOSED: number

CLOSING: number

CONNECTING: number

extensions: string

Возвращает выбранные сервером расширения, если таковые имеются.

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

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

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

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

OPEN: number

protocol: string

Возвращает выбранный сервером подпротокол, если таковой имеется. Может использоваться совместно с массивом в качестве второго аргумента конструктора для выполнения переговоров по подпротоколам.

readyState: number

Возвращает состояние соединения объекта WebSocket. Может принимать значения, описанные ниже.

url: string

Возвращает URL, который был использован для установления соединения WebSocket.

Методы

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

Закрывает соединение WebSocket, необязательно используя код как код закрытия соединения WebSocket и reason как причину закрытия соединения WebSocket.

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

Пересылает данные через соединение WebSocket. data может быть строкой, объектом Blob, ArrayBuffer или ArrayBufferView.

Статические свойства

CLOSED: number

CLOSING: number

CONNECTING: number

OPEN: number