vlocode-project - v2.4.3
    Preparing search index...

    Interface ProgressBarState

    interface ProgressBarState {
        details?: string[] | (() => string[]);
        label?: string;
        message?: string;
        total?: number;
        value?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    details?: string[] | (() => string[])

    Extra summary lines rendered, indented, beneath the gauge. The whole block is redrawn in place, so these can be updated freely. Each line is truncated to one terminal row. Pass a function to have it re-evaluated on every redraw (e.g. to surface a continuously-changing counter).

    label?: string

    Short label rendered in front of the gauge, e.g. the name of the running operation.

    message?: string

    Free-form trailing text on the gauge line (e.g. the item currently being processed). Truncated to fit the terminal width.

    total?: number

    Total number of units of work. May grow over time when the total is not known up-front; the underlying ProgressTracker treats the total as a moving target and clamps the ratio.

    value?: number

    Number of completed units of work.