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

    Interface IBufferLine

    Represents a line in the terminal's buffer.

    interface IBufferLine {
        isWrapped: boolean;
        length: number;
        getCell(x: number, cell?: IBufferCell): IBufferCell | undefined;
        translateToString(
            trimRight?: boolean,
            startColumn?: number,
            endColumn?: number,
        ): string;
    }
    Index
    isWrapped length
    getCell translateToString
    isWrapped: boolean

    Whether the line is wrapped from the previous line.

    length: number

    The length of the line, all call to getCell beyond the length will result in undefined. Note that this may exceed columns as the line array may not be trimmed after a resize, compare against Terminal.cols to get the actual maximum length of a line.

    • Gets a cell from the line, or undefined if the line index does not exist.

      Note that the result of this function should be used immediately after calling as when the terminal updates it could lead to unexpected behavior.

      Parameters

      • x: number

        The character index to get.

      • Optionalcell: IBufferCell

        Optional cell object to load data into for performance reasons. This is mainly useful when every cell in the buffer is being looped over to avoid creating new objects for every cell.

      Returns IBufferCell | undefined

    • Gets the line as a string. Note that this is gets only the string for the line, not taking isWrapped into account.

      Parameters

      • OptionaltrimRight: boolean

        Whether to trim any whitespace at the right of the line.

      • OptionalstartColumn: number

        The column to start from (inclusive).

      • OptionalendColumn: number

        The column to end at (exclusive).

      Returns string

    Settings
    Member Visibility

    On This Page
    Properties
    Methods