OptionalbarOptionaldetailsExtra 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).
OptionallabelShort label rendered in front of the gauge, e.g. the name of the running operation.
OptionalmessageFree-form trailing text on the gauge line (e.g. the item currently being processed). Truncated to fit the terminal width.
OptionalrefreshInterval in milliseconds at which the spinner and elapsed/ETA are refreshed even when no progress updates arrive. Defaults to 120ms.
OptionalstreamStream to render to; defaults to process.stdout. The stream is expected to be a TTY — the
caller is responsible for deciding whether interactive rendering is appropriate (see
ProgressBar.isInteractive).
OptionaltotalTotal 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.
OptionaltrackerTracker to render. When omitted a standalone tracker is created from the seed state. Pass an existing tracker to share one model between the bar and another consumer.
OptionalvalueNumber of completed units of work.
Width of the gauge in characters. Defaults to 24.