Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
xprogress
Advanced tools
Readme
Construct Dynamic, Flexible, extensible progressive CLI bar for the terminal built with NodeJS
Via NPM:
npm install xprogress
Create a basic progress bar that updates itself with 10% twice every second until it's at maximum
import ProgressBar from 'xprogress';
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);
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.
ProgressBar
(total[, slots][, opts])total
: <number>slots
: <HybridInput[]>opts
: <BarOpts>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
: Objectbar
: 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
.writeStream
: <WriteStream> The tty-ish writable stream we are writing to. Default: stdout.The global options shared by both ProgressBar and ProgressStream.
VariableOpts
extends cStringd.raw
: Object
tag
: <any> Floating mutable tag to be attached to the barbar
: <string> The progress bar itselflabel
: <any> The label to be attached to the bartotal
: <any> The maximum value for the entire duration of the barflipper
: <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 prettyMssize
: <ByteString> Human readable size for the number of total transferred bytes. Parsed by xbytesspeed
: <string> Human readable speed for the number of bits transferred per second. Parsed by xbytesprogress
: <ProgressStreamSlice> The Progress Objecteta: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 prettyMsslot: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 xbytesslot:total
: <ByteString> Human readable size for the total number of bytes that can be processed by the active chunk. Parsed by xbytesslot:runtime
: <string> Runtime for the active chunk. Parsed by prettyMsslot:runtime:raw
: <number> Runtime for the active chunk.slot:percentage
: <string> Integer defining the active slot completion percentageslot:size:total
: <ByteString> Human readable size for the total number of bytes transferred in a single instanceHybridInput
: string|number|number[]This content here is parsed by pad-ratio in the construct of an HybridInput.
Feel free to clone, use in adherance to the license. Pull requests are very much welcome.
git clone https://github.com/miraclx/xprogress.git
cd xprogress
npm install
# hack on code
Apache 2.0 © Miraculous Owonubi (@miraclx) <omiraculous@gmail.com>
FAQs
Dynamic, Flexible, extensible progressive CLI bar for the terminal built with NodeJS
The npm package xprogress receives a total of 1,742 weekly downloads. As such, xprogress popularity was classified as popular.
We found that xprogress demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.