pro

@articulate/progress

Cheap, functional, terminal progress bar

Showing:

Popularity

Downloads/wk

262

Maintenance

No Maintenance Data Available

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

@articulate/progress

@articulate/progress Build Status Coverage Status NSP Status

@articulate/progress

Cheap, functional, terminal progress bar.

Next time you're tempted to process.stderr.write('.') to track the progress of a script... don't. Use this instead.

API

progress : Object -> Number -> ()

To setup your progress bar, execute the module with an optional options object:

const progress = require('@articulate/progress')({ /* options here */ })

The following options are accepted:

NameTypeDefaultDescription
labelString'progress'custom label for your progress bar
streamstream.Writableprocess.stderroutput stream for progress
widthNumber24max width of the bar

The returned function accepts a progress ratio between 0 and 1, and writes the progress bar to the output stream. Each time it is called, it will overwrite the previous state of the progress to appear animated in the console.

const progress = require('@articulate/progress')()

progress(0.55)
//> progress: ⣠ [==============          ] 55%

See demo.js for a slightly more complex example.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial