Interface WsFrame

The wire frame exchanged with clients (matching the @stone-js/realtime client protocol).

interface WsFrame {
    channel?: string;
    event?: string;
    payload?: unknown;
    type?: string;
    [key: string]: unknown;
}

Properties

channel?: string

The channel the frame targets.

event?: string

The event name (for data frames).

payload?: unknown

The payload (for data frames).

type?: string

The frame kind (event, subscribe, unsubscribe); absent frames are data.