global.WebSocket — Kuito Dokumentation

Verwendung

Keep a connection open

tsx

const socket = new WebSocket('wss://chat.example.com', ['v2']);

socket.onopen = () => socket.send(JSON.stringify({ hello: true }));
socket.onmessage = ({ data }) => console.log(data); // a string, or an ArrayBuffer
socket.onclose = ({ code, reason, wasClean }) => {};

Konstruktoren

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

Parameter

Name	Typ	Erforderlich	Beschreibung
`url`	`string \| URL`	Ja	—
`protocols`	`string \| string[]`	Nein	—

Rückgabe

WebSocket

Eigenschaften und Methoden 19

Name	Typ	Erforderlich	Beschreibung
`prototype`schreibgeschützt	`WebSocket`	Ja	—
`CONNECTING`schreibgeschützt	`0`	Ja	—
`OPEN`schreibgeschützt	`1`	Ja	—
`CLOSING`schreibgeschützt	`2`	Ja	—
`CLOSED`schreibgeschützt	`3`	Ja	—
`url`schreibgeschützt	`string`	Ja	—
`readyState`schreibgeschützt	`0 \| 2 \| 1 \| 3`	Ja	—
`protocol`schreibgeschützt	`string`	Ja	The subprotocol the server chose, once open.
`bufferedAmount`schreibgeschützt	`number`	Ja	Always 0: bytes are not counted on their way out.
`extensions`schreibgeschützt	`string`	Ja	—
`binaryType`	`"arraybuffer"`	Ja	Only 'arraybuffer': there is no Blob.
`onopen`	`(event: WebSocketEvent) => void`	Ja	—
`onmessage`	`(event: WebSocketEvent) => void`	Ja	—
`onerror`	`(event: WebSocketEvent) => void`	Ja	—
`onclose`	`(event: WebSocketEvent) => void`	Ja	—
`addEventListener`	`(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void) => void`	Ja	—
`removeEventListener`	`(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void) => void`	Ja	—
`send`	`(data: string \| ArrayBuffer \| ArrayBufferView) => void`	Ja	—
`close`	`(code?: number, reason?: string) => void`	Ja	—

onopen — Methodensignaturen

Signaturen

(event: WebSocketEvent): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`WebSocketEvent`	Ja	—

Rückgabe

void

onmessage — Methodensignaturen

Signaturen

(event: WebSocketEvent): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`WebSocketEvent`	Ja	—

Rückgabe

void

onerror — Methodensignaturen

Signaturen

(event: WebSocketEvent): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`WebSocketEvent`	Ja	—

Rückgabe

void

onclose — Methodensignaturen

Signaturen

(event: WebSocketEvent): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`WebSocketEvent`	Ja	—

Rückgabe

void

addEventListener — Methodensignaturen

Signaturen

(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`type`	`"close" \| "open" \| "error" \| "message"`	Ja	—
`listener`	`(event: WebSocketEvent) => void`	Ja	—

Rückgabe

void

removeEventListener — Methodensignaturen

Signaturen

(type: WebSocketEvent["type"], listener: (event: WebSocketEvent) => void): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`type`	`"close" \| "open" \| "error" \| "message"`	Ja	—
`listener`	`(event: WebSocketEvent) => void`	Ja	—

Rückgabe

void

send — Methodensignaturen

Signaturen

(data: string | ArrayBuffer | ArrayBufferView): void

Parameter

Name	Typ	Erforderlich	Beschreibung
`data`	`string \| ArrayBuffer \| ArrayBufferView<ArrayBufferLike>`	Ja	—

Rückgabe

void

close — Methodensignaturen

Signaturen

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

Parameter

Name	Typ	Erforderlich	Beschreibung
`code`	`number`	Nein	—
`reason`	`string`	Nein	—

Rückgabe

void

Generiert aus den öffentlichen TypeScript-Deklarationen: Signaturen, Props und Standardwerte stammen aus der geprüften Quelle, Beschreibungen aus deren JSDoc. Kein Standardwert ist erfunden.