API reference / @chanx-js/client / core / WebSocketLike

Interface: WebSocketLike

Defined in: packages/client/src/core/socket.ts:8

The slice of the WebSocket API the runtime uses, so tests can substitute a fake.

Properties

onclose

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

Defined in: packages/client/src/core/socket.ts:13

---

onerror

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

Defined in: packages/client/src/core/socket.ts:14

---

onmessage

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

Defined in: packages/client/src/core/socket.ts:15

---

onopen

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

Defined in: packages/client/src/core/socket.ts:12

---

readyState

readyState: number;

Defined in: packages/client/src/core/socket.ts:9

Methods

close()

close(code?, reason?): void;

Defined in: packages/client/src/core/socket.ts:11

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void

---

send()

send(data): void;

Defined in: packages/client/src/core/socket.ts:10

Parameters

Parameter	Type
data	string

Returns

void