Highly configurable status indicators for your node.js cli.
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.gitignore
LICENSE.md
README.md
changelog.md
index.js
package.json
test.js

README.md

cli-status

Highly configurable status indicators for your node.js cli.

Local Installation:

cli-status is an npm module. Once you have npm, you can run this to locally install cli-status into the current directory.

$> npm install cli-status

Or, add this as a dependency in your project's package.json

"dependencies": {
  "cli-status": "0.1.x"
}

How to use:

Configuration options

Manual stepping:

var status = require('cli-status');

status.configure({
  // See options
});

while (something) {
  status.step(progress);
}

Automatic polling:

var status = require('cli-status');
var files = [];

status.configure({
  // See options
  type: '/',
    total: server.numFiles()
}).start(function() {
  return files.length;
});

while (files.length < server.numFiles()) {
  var data = server.getNext();
  files.push(data);
}

status.end();
// Optional if files.length >= options.total is guaranteed.

Testing:

Install or clone the repo, then run:

$> npm test