ProgressOptions

The ProgressOptions interface defines the configuration options for a progress bar in ts-better-console. These options allow you to customize the labels and the bar appearance including length, symbols, animation, and colors.

Type Definition

The ProgressOptions interface includes the following properties:

• label: An optional ProgressLabelPair object that provides two labels — one shown while the progress is active and another after completion.
• bar: An optional ProgressBarOptions object that configures the bar length, symbols, animation, and per-state colors.

interface ProgressOptions {
  label?: ProgressLabelPair;
  bar?: ProgressBarOptions;
}

Usage

You can pass ProgressOptions when creating a progress bar to customize its appearance:

import { Progress } from "ts-better-console";

const bar = new Progress("Files", 100, {
label: {
while: "Installing",
past: "Installed",
},
bar: {
length: 30,
animation: "rainbow",
color: { completed: "green" },
},
});