interface IWebSocketTransport

Minimal structural WebSocket surface used by the client.

Properties

readonly
readyState: number

Browser-compatible ready-state number (0 connecting, 1 open).

onopen: ((event: Event) => void) | null

Open callback installed by the client.

onmessage: ((event: MessageEvent) => void) | null

Message callback installed by the client.

onclose: ((event: CloseEvent) => void) | null

Close callback installed by the client.

onerror: ((event: Event) => void) | null

Error callback installed by the client.

Methods

send(data: string): void

Sends one text frame.

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

Closes the connection.

Usage

import { type IWebSocketTransport } from "sdk/src/index.ts";