gespenst API - v0.1.0
    Preparing search index...

    Interface TerminalBufferState

    Active screen and scroll position metadata for terminal buffer consumers.

    interface TerminalBufferState {
        cursorAttributes?: TerminalCursorAttributes;
        cursorX: number;
        cursorY: number;
        modes?: TerminalModeState;
        revision: number;
        screen: "normal" | "alternate";
        scrollbackRows: number;
        totalRows: number;
        viewportLength: number;
        viewportY: number;
    }
    Index
    cursorAttributes? cursorX cursorY modes? revision screen scrollbackRows totalRows viewportLength viewportY
    cursorAttributes?: TerminalCursorAttributes

    Current SGR attributes used for subsequently written cells.

    cursorX: number

    Cursor column on the active screen.

    cursorY: number

    Cursor row on the active screen.

    modes?: TerminalModeState

    Authoritative terminal modes at this revision.

    revision: number

    Monotonic revision for buffer-affecting operations.

    screen: "normal" | "alternate"

    Currently active primary or alternate screen.

    scrollbackRows: number

    Number of retained rows above the bottom viewport.

    totalRows: number

    Number of retained rows, including the visible viewport.

    viewportLength: number

    Number of rows in the visible viewport.

    viewportY: number

    Absolute zero-based offset of the first visible row.

    Settings
    Member Visibility

    On This Page
    Properties