progress-title

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

Usage

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

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-title aliases progress-title/source/index.js
• progress-title/source/index.js is ESNext source code for Node.js 10 || 12 || 14 || 16 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 accomlish 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.

Contribute

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

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton — view contributions

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton — view contributions

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:

• MIT License