bevryprogress-title
Your usual progress bar, but this time it is displayed within the terminal's title, which is much simpler
Usage
const Progress = require('progress-title')
// Create the progress session, you can pass configuration into the create method
// see the API Documentation for details
const progress = Progress.create()
// When you are ready to start progress updates
progress.start()
// To write a progress update, you should call these manually
// as otherwise everything will be too quick to see
progress.update('message A')
// => message A
progress.update('message B', { total: 2, done: 1, executing: 1 })
// => message B [50% — 1 running]
progress.update('message C', { total: 10, completed: 5, running: 5 })
// => message C [50% — 5 running]
// To finish the progress updates
progress.stop()Install
npm
- Install:
npm install --save progress-title - Import:
import * as pkg from ('progress-title') - Require:
const pkg = require('progress-title')
Editions
This package is published with the following editions:
progress-titlealiasesprogress-title/index.cjswhich uses the Editions Autoloader to automatically select the correct edition for the consumer's environmentprogress-title/source/index.jsis ESNext source code for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modulesprogress-title/edition-node-4/index.jsis ESNext compiled for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
TypeScript
This project provides its type information via inline JSDoc Comments. To make use of this in TypeScript, set your maxNodeModuleJsDepth compiler option to 5 or thereabouts. You can accomplish this via your tsconfig.json file like so:
{
"compilerOptions": {
"maxNodeModuleJsDepth": 5
}
}History
Discover the release history by heading on over to the HISTORY.md file.
Backers
Code
Discover how to contribute via the CONTRIBUTING.md file.
Authors
- Benjamin Lupton — Accelerating collaborative wisdom.
Maintainers
- Benjamin Lupton — Accelerating collaborative wisdom.
Contributors
Finances
Sponsors
- Andrew Nesbitt — Software engineer and researcher
- Balsa — We're Balsa, and we're building tools for builders.
- Codecov — Empower developers with tools to improve code quality and testing.
- Poonacha Medappa
- Rob Morris
- Sentry — Real-time crash reporting for your web apps, mobile apps, and games.
- Syntax — Syntax Podcast
Donors
- Andrew Nesbitt
- Armen Mkrtchian
- Balsa
- Chad
- Codecov
- dr.dimitru
- Elliott Ditman
- entroniq
- GitHub
- Hunter Beast
- Jean-Luc Geering
- Michael Duane Mooring
- Michael Harry Scepaniak
- Mohammed Shah
- Mr. Henry
- Nermal
- Pleo
- Poonacha Medappa
- Rob Morris
- Robert de Forest
- Sentry
- ServieJS
- Skunk Team
- Syntax
- WriterJohnBuck
License
Unless stated otherwise all works are:
- Copyright © Benjamin Lupton
and licensed under: