openmixer — generated API reference
    Preparing search index...

    Interface ConsoleWatchHandlers

    How a watcher learns the stream's own state, apart from the rows it carries.

    interface ConsoleWatchHandlers {
        onDown?: (error: unknown) => void;
        onFrame: (frame: ConsoleFrame) => void;
        onOpen?: () => void;
        onReopen?: () => void;
    }
    Index
    onDown? onFrame onOpen? onReopen?
    onDown?: (error: unknown) => void

    The stream ended or failed. A retry is already scheduled unless the watch was stopped.

    onFrame: (frame: ConsoleFrame) => void
    onOpen?: () => void

    The first successful open. The burst that follows IS the snapshot.

    onReopen?: () => void

    A LATER open. Frames sent while we were away cannot be replayed, so everything held across the gap is suspect — this is where a consumer re-reads, which is query-and-compare applied to a client. It is deliberately a different signal from onOpen: re-reading the world on the first open recreates the request storm the stream removes.

    Settings
    Member Visibility

    On This Page
    Properties