global.WebSocket — Kuito Documentation

Utilisation

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 }) => {};

Constructeurs

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

Paramètres

Nom	Type	Requis	Description
`url`	`string \| URL`	Oui	—
`protocols`	`string \| string[]`	Non	—

Retourne

WebSocket

Propriétés et méthodes 19

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

onopen — signatures de méthode

Signatures

(event: WebSocketEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`WebSocketEvent`	Oui	—

Retourne

void

onmessage — signatures de méthode

Signatures

(event: WebSocketEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`WebSocketEvent`	Oui	—

Retourne

void

onerror — signatures de méthode

Signatures

(event: WebSocketEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`WebSocketEvent`	Oui	—

Retourne

void

onclose — signatures de méthode

Signatures

(event: WebSocketEvent): void

Paramètres

Nom	Type	Requis	Description
`event`	`WebSocketEvent`	Oui	—

Retourne

void

addEventListener — signatures de méthode

Signatures

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

Paramètres

Nom	Type	Requis	Description
`type`	`"close" \| "open" \| "error" \| "message"`	Oui	—
`listener`	`(event: WebSocketEvent) => void`	Oui	—

Retourne

void

removeEventListener — signatures de méthode

Signatures

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

Paramètres

Nom	Type	Requis	Description
`type`	`"close" \| "open" \| "error" \| "message"`	Oui	—
`listener`	`(event: WebSocketEvent) => void`	Oui	—

Retourne

void

send — signatures de méthode

Signatures

(data: string | ArrayBuffer | ArrayBufferView): void

Paramètres

Nom	Type	Requis	Description
`data`	`string \| ArrayBuffer \| ArrayBufferView<ArrayBufferLike>`	Oui	—

Retourne

void

close — signatures de méthode

Signatures

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

Paramètres

Nom	Type	Requis	Description
`code`	`number`	Non	—
`reason`	`string`	Non	—

Retourne

void

Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.