OPEN TECH FOUNDATION

The Customizable CLI Progress Bars.

🚀 @opentf/std - An Extensive JavaScript Standard Library. Please review and give feedback.

Features

• Single & Multi Progress Bars

• Customizable (colors, size, etc)

• TypeScript Support

Installation

Install it using your favourite package manager.

npm install @opentf/cli-pbar

yarn add @opentf/cli-pbar

pnpm add @opentf/cli-pbar

bun add @opentf/cli-pbar

Syntax

new ProgressBar(options?: Options)

Usage

Single progress bar.

import { ProgressBar } from '@opentf/cli-pbar';

const pBar = new ProgressBar();
pBar.start({ total: 100 });
pBar.update({ value: 50 });
pBar.update({ value: 100 });
pBar.stop();

Multi progress bar.

import { ProgressBar } from '@opentf/cli-pbar';

const multiPBar = new ProgressBar({ size: 'MEDIUM' });
multiPBar.start();
const b1 = multiPBar.add({ total: 100 });
const b2 = multiPBar.add({ total: 100 });
const b3 = multiPBar.add({ total: 100 });
b1.update({ value: 23 });
b3.update({ value: 35 });
b2.update({ value: 17 });
multiPBar.stop();

[!TIP] It is recommended to use MEDIUM sized bars in multi progress bars for better visuals.

Examples

Using inc() to increment the progress bar value, hide the percent & show the count.

import { sleep, aForEach } from '@opentf/std';
import { ProgressBar } from '@opentf/cli-pbar';

const arr = ['Apple', 'Mango', 'Orange', 'Grapes', 'Pear', 'Guava'];

const pBar = new ProgressBar({
  color: 'pi',
  bgColor: 'r',
  showPercent: false,
  showCount: true,
  prefix: 'Processing Fruits',
});

pBar.start({ total: arr.length });

await aForEach(arr, async (f) => {
  pBar.inc({ suffix: f });
  await sleep(500);
});

pBar.stop();

API

options:

Instance methods:

start(obj?: Partial<Bar>): void

After the method is called, the progress bar starts rendering.

Bar:

add(bar: Partial<Bar>): { update: (bar: Partial<Bar>) => void }

In multi-progress bars, it appends a progress bar to the container and returns an object with a method to update it.

update(bar: Partial<Bar>): void

In updates the current progress bar instance.

inc(bar: Partial<Bar>): void

In increments the progress bar value and optionaly updates the other bar props.

stop(msg?: string): void

Stops the current progress bar instance with the current state and optionally clears the progress bar when autoClear is true.

You can also pass msg text to be displayed after the instance stops.

Supported Color Keys

Related

• @opentf/std - An Extensive JavaScript Standard Library.

• @opentf/cli-styles - Style your CLI text using ANSI escape sequences.

License

Copyright (c) 2021, Thanga Ganapathy (MIT License).