global.WebSocketEvent — Kuito Documentação

Utilização

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

Declaração do tipo

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

Membros 7

Nome	Tipo	Obrigatório	Descrição
`type`só de leitura	`"close" \| "open" \| "error" \| "message"`	Sim	—
`target`só de leitura	`WebSocket`	Sim	—
`data`só de leitura	`string \| ArrayBuffer`	Não	A text message as a string, a binary one as an ArrayBuffer.
`message`só de leitura	`string`	Não	The platform's description of an error.
`code`só de leitura	`number`	Não	—
`reason`só de leitura	`string`	Não	—
`wasClean`só de leitura	`boolean`	Não	—

Gerado a partir das declarações TypeScript públicas: assinaturas, props e predefinições vêm da fonte verificada, as descrições da sua JSDoc. Nenhuma predefinição é inventada.