global.WebSocketEvent — Kuito Dokumentation

Verwendung

Keep a connection open

Dieser Typ wird verwendet von 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 }) => {};

Typdeklaration

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;
  }

Mitglieder 7

Name	Typ	Erforderlich	Beschreibung
`type`schreibgeschützt	`"close" \| "open" \| "error" \| "message"`	Ja	—
`target`schreibgeschützt	`WebSocket`	Ja	—
`data`schreibgeschützt	`string \| ArrayBuffer`	Nein	A text message as a string, a binary one as an ArrayBuffer.
`message`schreibgeschützt	`string`	Nein	The platform's description of an error.
`code`schreibgeschützt	`number`	Nein	—
`reason`schreibgeschützt	`string`	Nein	—
`wasClean`schreibgeschützt	`boolean`	Nein	—

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