openmixer — generated API reference
    Preparing search index...

    Interface ConvergenceFrame

    One console-stream event, as the intake hands it over: the GET body plus the rev stamp.

    interface ConvergenceFrame {
        board?: boolean;
        id: Readonly<Record<string, unknown>>;
        path: string;
        rev?: number;
        state: object;
    }
    Index
    board? id path rev? state
    board?: boolean

    Whether this frame arrived on the console's BOARD stream, ordered against that stream's own burst (Q5, 2026-09-01-http2-console-streams.md §8, shape a). undefined/true is trusted (every intake that predates this field, and every board frame); false marks a frame KNOWN to have arrived on the heartbeat's own independent row stream, which nothing orders against the board's burst — such a tick can update steady-state bookkeeping but must never conclude a re-read in progress.

    id: Readonly<Record<string, unknown>>
    path: string
    rev?: number

    The console revision as of when the frame was produced; absent on a pre-instrument server.

    state: object

    Settings
    Member Visibility

    On This Page
    Properties