https://github.com/davidcsally/node-progress-bar

A fun NPM module for printing the status of the task you are running in your console
https://github.com/davidcsally/node-progress-bar

Last synced: 2 months ago
JSON representation

A fun NPM module for printing the status of the task you are running in your console

• Host: GitHub
• URL: https://github.com/davidcsally/node-progress-bar
• Owner: davidcsally
• Created: 2018-03-03T08:58:40.000Z (almost 7 years ago)
• Default Branch: develop
• Last Pushed: 2018-03-08T05:53:01.000Z (almost 7 years ago)
• Last Synced: 2024-10-15T00:31:34.419Z (3 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/node-progress-bar
• Size: 127 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Coverage Status](https://coveralls.io/repos/github/davidcsally/node-progress-bar/badge.svg?branch=master)](https://coveralls.io/github/davidcsally/node-progress-bar?branch=master)

[![Build Status](https://travis-ci.org/davidcsally/node-progress-bar.svg?branch=master)](https://travis-ci.org/davidcsally/node-progress-bar)

[![npm version](https://badge.fury.io/js/node-progress-bar.svg)](https://badge.fury.io/js/node-progress-bar)

Ever wanted to print the progress of a loop you are running, but not clutter up your console?

Maybe you are updating a large batch of documents in your database, that requires you to iterate over them?

Printing the progress has never been easier! Node-progress-bar makes this easy!

How to use:

```

 npm install --save-dev node-progress-bar 

```

or 

```

 yarn add node-progress-bar --dev 

```

at the top of your node file, add:

``` const progressBar = require('node-progress-bar'); ```

then call the function in your operation!

```

const test = (i) => {

  if (i <= 100) {

    setTimeout(() => {

      print(i, 100);

      test(i += 1);

    }, 50);

  }

}

test(0);

```

It's that simple!

Coming soon... 

  1. [ ] custom print messages

  2. [ ] progress animations

  3. [ ] progress bar customizations

  4. [ ] your suggestions!

Thanks for checking out node-progress-bar!