Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

progress-title

2.3.0 • Public • Published

progress-title

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Your usual progress bar, but this time it is displayed within the terminal's title, which is much simpler

Install

npm

  • Install: npm install --save progress-title
  • Require: require('progress-title')

Editions

This package is published with the following editions:

  • progress-title aliases progress-title/source/index.js
  • progress-title/source/index.js is esnext source code with require for modules

Environments older than Node.js v8 may need Babel's Polyfill or something similar.

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 accomlish this via your tsconfig.json file like so:

{
  "compilerOptions": {
    "maxNodeModuleJsDepth": 5
  }
}

Usage

API Documentation.

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()

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

  • Copyright © 2018+ Benjamin Lupton

and licensed under:

Install

npm i progress-title

DownloadsWeekly Downloads

154

Version

2.3.0

License

MIT

Unpacked Size

23.4 kB

Total Files

7

Last publish

Collaborators

  • avatar