Interface: WebSocket

Defined in: types/desktop-engine.d.ts:4116

A WebSocket connection

Extends

• EventTarget<WebSocketEventMap>

Properties

binaryType

binaryType: "blob" | "arraybuffer";

Defined in: types/desktop-engine.d.ts:4127

What binary messages are: "blob" (the default, like browsers) or "arraybuffer"; other values are ignored

---

bufferedAmount

readonly bufferedAmount: number;

Defined in: types/desktop-engine.d.ts:4125

Bytes passed to send() that haven't been sent yet

---

CLOSED

readonly CLOSED: 3;

Defined in: types/desktop-engine.d.ts:4139

---

CLOSING

readonly CLOSING: 2;

Defined in: types/desktop-engine.d.ts:4138

---

CONNECTING

readonly CONNECTING: 0;

Defined in: types/desktop-engine.d.ts:4136

---

extensions

readonly extensions: string;

Defined in: types/desktop-engine.d.ts:4123

---

onclose

onclose: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4131

---

onerror

onerror: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4130

---

onmessage

onmessage: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4129

---

onopen

onopen: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4128

---

OPEN

readonly OPEN: 1;

Defined in: types/desktop-engine.d.ts:4137

---

protocol

readonly protocol: string;

Defined in: types/desktop-engine.d.ts:4122

The subprotocol the server picked

---

readyState

readonly readyState: 0 | 1 | 2 | 3;

Defined in: types/desktop-engine.d.ts:4120

WebSocket.CONNECTING, OPEN, CLOSING or CLOSED

---

url

readonly url: string;

Defined in: types/desktop-engine.d.ts:4118

The URL, with http(s) turned into ws(s)

Methods

addEventListener()

addEventListener<K>(
   type, 
   listener, 
   options?
): void;

Defined in: types/desktop-engine.d.ts:3810

Type Parameters

Type Parameter
K extends keyof WebSocketEventMap

Parameters

Parameter	Type
type	K
listener	(this, event) => void
options?	AddEventListenerOptions

Returns

void

Inherited from

EventTarget.addEventListener

---

close()

close(code?, reason?): void;

Defined in: types/desktop-engine.d.ts:4135

code is 1000 (the default) or 3000-4999, reason at most 123 bytes of UTF-8

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void

---

dispatchEvent()

dispatchEvent(event): boolean;

Defined in: types/desktop-engine.d.ts:3813

Returns false when a listener called preventDefault() on a cancelable event

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

EventTarget.dispatchEvent

---

removeEventListener()

removeEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:3811

Type Parameters

Type Parameter
K extends keyof WebSocketEventMap

Parameters

Parameter	Type
type	K
listener	(this, event) => void

Returns

void

Inherited from

EventTarget.removeEventListener

---

send()

send(data): void;

Defined in: types/desktop-engine.d.ts:4133

Sends a text or binary message; throws an "InvalidStateError" DOMException while connecting, dropped once closing

Parameters

Parameter	Type
data	| string | ArrayBuffer | ArrayBufferView<ArrayBufferLike> | Blob

Returns

void