Stone.js API
    Preparing search index...

    Interface WsFrame

    The wire frame exchanged with clients (and the isomorphic @stone-js/realtime client): a type, a channel, and for data frames an event and payload.

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

    Indexable

    • [key: string]: unknown

      Frames may carry arbitrary extra fields.

    Index
    channel? event? payload? type?
    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 treated as data.

    Settings
    Member Visibility

    On This Page
    Properties