xprogress
Dynamic, Flexible, extensible progressive CLI bar for the terminal built with NodeJS
Last updated 2 months ago by miraclx .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install xprogress 
SYNC missed versions from official npm registry.

xprogress

Construct Dynamic, Flexible, extensible progressive CLI bar for the terminal built with NodeJS

DOCUMENTATION INCOMPLETE

Features

  • Stream management functionality

NPM Version NPM Downloads

NPM

Installing

Via NPM:

npm install xprogress

Usage

// Node CommonJS
const ProgressBar = require('xprogress');
// Or ES6
import ProgressBar from 'xprogress';

Example

Create a basic progress bar that updates itself with 10% twice every second until it's at maximum

const ProgressBar = require('xprogress');

const bar = new ProgressBar(100);

const interval = setInterval(() => {
  bar.tick(10).draw();
  if (bar.isComplete()) {
    bar.end(`The bar completed\n`);
    clearInterval(interval);
  }
}, 500);

XProgress Example Result

How It Works

ProgressBar uses stringd to parse content within ProgressBar::template with variables in ProgressBar::variables and then displays them on the terminal. This sequence occurs for every time ProgressBar::draw() is called.

API

new ProgressBar(total[, slots][, opts])

Create and return an xprogress instance slots define the percentage to each part of the progressbar. This is parsed by pad-ratio to a max of 100.

const bar = new ProgressBar(100, [20, 44]);

GlobOpts: Object

  • bar: Object
    • blank: <string> Content to use for the blank portion of the progressbar. Default: '-'.
    • filler: <string> Content to use for the filled portion of the progressbar. Default: '#'.
    • header: <string> Content to use for the header(s) of progressbars. Default: ''.
    • colorize: <boolean> Whether or not to allow colors in the bar. Default: true.
    • separator: <string> Content to use when separating bars. Default: ''.
    • pulsateSkip: <number> Distance away at which to skip a pulsating bar. Default: 15.
    • pulsateLength: <number> The length of a pulsating progressbar. Default: 15.
  • clean: <boolean> Whether or not to clear the progressbar buffer on the terminal after ProgressBar::end() has been called. Default: false.
  • flipper: <string|string[]> Content(s) to use for the progressbar flipper. This would cycle through all indexes in this property for everywhere :{flipper} is speified. Default: ['|', '/', '-', '\'].
  • pulsate: <boolean> Whether or not to use a pulsate view for the progressbar. Default: false.
  • template: <string|string[]> The template to use for the progressbar view. This is parsed by stringd. with this.variables Default: ''.
  • variables: <VariableOpts> Variables with which to parse this.template, extended with cStringd.raw.
  • forceFirst: <boolean> Whether or not to force a multi-bar progressbar to a single bar (useful either when terminal width is too small or when filled with excess addons). Default: false.

The global options shared by both ProgressBar and ProgressStream.

VariableOpts extends cStringd.raw: Object

  • tag: <any> Floating mutable tag to be attached to the bar
  • *bar: <string> The progress bar itself
  • *label: <any> The label to be attached to the bar
  • *total: <any> The maximum value for the entire duration of the bar
  • flipper: <any> The flipper as defined in the definition for the progressbar. Default: ['|', '/', '-', '\'].
  • *completed: <any> The value for the completion level of the entire bar activity. Generated from ProgressBar::average().completed
  • *remaining: <any>
  • *percentage: <any>

Variables with which to parse this.template, extended with cStringd.raw. variables prepended with * will be ignored anywhere else besides wherever's explicitly requesting a drawn bar.

StreamVariables extends VariableOpts: Object

  • eta: <string> Duration for the entire progress to end. Parsed by prettyMs
  • size: <ByteString> Human readable size for the number of total transferred bytes. Parsed by xbytes
  • speed: <string> Human readable speed for the number of bits transferred per second. Parsed by xbytes
  • progress: <ProgressStreamSlice> The Progress Object
  • eta:raw: <number[> Duration estimate of how long it would take for the stream to end based on the number of bytes being steadily transmitted per second.
  • slot:bar: <string> The bar for the active chunk of the progressbar.
  • slot:blank: <string> The character with which to be used as the slot's blank character.
  • slot:eta: <string[> Duration estimate for the active chunk to be completed. Parsed by prettyMs
  • slot:eta:raw: <number> Duration estimate for the active chunk to be completed.
  • slot:filler: <string|string[]> The character(s) with which to be used as the slot's filler character.
  • slot:header: <string> The character with which to be used as the slot's header character.
  • slot:size: <ByteString> Human readable size for the number of transferred bytes specific for the active chunk. Parsed by xbytes
  • slot:total: <ByteString> Human readable size for the total number of bytes that can be processed by the active chunk. Parsed by xbytes
  • slot:runtime: <string> Runtime for the active chunk. Parsed by prettyMs
  • slot:runtime:raw: <number> Runtime for the active chunk.
  • slot:percentage: <string> Integer defining the active slot completion percentage
  • slot:size:total: <ByteString> Human readable size for the total number of bytes transferred in a single instance

HybridInput: string|number|number[]

This content here is parsed by pad-ratio in the construct of an HybridInput.

Development

Building

Feel free to clone, use in adherance to the license and perhaps send pull requests

git clone https://github.com/miraclx/xprogress.git
cd xprogress
npm install
# hack on code
npm run build

License

Apache 2.0 © Miraculous Owonubi (@miraclx) <omiraculous@gmail.com>

Current Tags

  • 0.15.1                                ...           latest (2 months ago)

15 Versions

  • 0.15.1                                ...           2 months ago
  • 0.13.0                                ...           3 months ago
  • 0.12.1                                ...           3 months ago
  • 0.12.0                                ...           3 months ago
  • 0.11.0                                ...           3 months ago
  • 0.10.1                                ...           3 months ago
  • 0.10.0                                ...           3 months ago
  • 0.9.10-0                                ...           8 months ago
  • 0.9.9                                ...           8 months ago
  • 0.9.8                                ...           8 months ago
  • 0.9.7                                ...           8 months ago
  • 0.9.6                                ...           9 months ago
  • 0.8.0                                ...           a year ago
  • 0.7.0                                ...           a year ago
  • 0.5.0                                ...           a year ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 15
Dependencies (9)
Dev Dependencies (11)
Dependents (2)

Copyright 2014 - 2017 © taobao.org |