ProgressBarOptions

The ProgressBarOptions interface defines the visual configuration for a progress bar in ts-better-console. It controls the bar length, display symbols, animation style, and per-state colors.

Type Definition

The ProgressBarOptions interface includes the following properties:

• loadedSymbol: Character used for the filled portion of the bar. Defaults to "█".
• bufferedSymbol: Character used for the buffered portion. Defaults to "▒".
• emptySymbol: Character used for the empty portion. Defaults to "-".
• length: The bar width in characters, or "full-width" to fill the terminal. Defaults to 40. Minimum is 10.
• animation: A ProgressAnimationOptions object to enable a rainbow animation (see below), or false to disable. Defaults to false.
• color: A ProgressBarStateColor object to customize colors for each bar segment and state.
• position: Where to render the bar — "inline", "top", or "bottom". Defaults to "inline".

interface ProgressBarOptions {
  loadedSymbol?: string;
  bufferedSymbol?: string;
  emptySymbol?: string;
  length?: number | "full-width";
  animation?: false | ProgressAnimationOptions;
  color?: ProgressBarStateColor;
  position?: FixedPosition;
}

ProgressAnimationOptions

When animation is not false, pass a ProgressAnimationOptions object to configure the animation:

• type: "rainbow" — a scrolling parallax wave using the 6-color 4-bit palette; or "rainbow-smooth" — a full-spectrum 8-bit gradient.
• speed (optional): Animation interval in milliseconds. Defaults to 80.
• size (optional): Wave size of the animation. Defaults to 0.

interface ProgressAnimationOptions {
  type: "rainbow" | "rainbow-smooth";
  speed?: number; // ms, default 80
  size?: number; // wave size, default 0
}

Usage

Pass ProgressBarOptions via the bar property of ProgressOptions:

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

const bar = new Progress("Building", 100, {
bar: {
loadedSymbol: "#",
emptySymbol: ".",
length: 50,
animation: { type: "rainbow" },
color: {
loaded: "cyan",
completed: "green",
},
},
});