global.WebSocketEvent — Kuito Documentation

Utilisation

Keep a connection open

Ce type est utilisé par global.WebSocket

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

Déclaration du type

interface WebSocketEvent {
    readonly type: 'open' | 'message' | 'error' | 'close';
    readonly target: WebSocket;
    /** A text message as a string, a binary one as an ArrayBuffer. */
    readonly data?: string | ArrayBuffer;
    /** The platform's description of an error. */
    readonly message?: string;
    readonly code?: number;
    readonly reason?: string;
    readonly wasClean?: boolean;
  }

Membres 7

Nom	Type	Requis	Description
`type`lecture seule	`"close" \| "open" \| "error" \| "message"`	Oui	—
`target`lecture seule	`WebSocket`	Oui	—
`data`lecture seule	`string \| ArrayBuffer`	Non	A text message as a string, a binary one as an ArrayBuffer.
`message`lecture seule	`string`	Non	The platform's description of an error.
`code`lecture seule	`number`	Non	—
`reason`lecture seule	`string`	Non	—
`wasClean`lecture seule	`boolean`	Non	—

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.