progress-title v4.8.0

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

npm

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

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

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

These amazing people are maintaining this project:

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

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

Unless stated otherwise all works are:

and licensed under: