global.WebSocketEvent — Kuito Documentation

Usage

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

Type declaration

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

Members 7

Name	Type	Required	Description
`type`readonly	`"close" \| "open" \| "error" \| "message"`	Yes	—
`target`readonly	`WebSocket`	Yes	—
`data`readonly	`string \| ArrayBuffer`	No	A text message as a string, a binary one as an ArrayBuffer.
`message`readonly	`string`	No	The platform's description of an error.
`code`readonly	`number`	No	—
`reason`readonly	`string`	No	—
`wasClean`readonly	`boolean`	No	—

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.