multimeter

Control multiple ANSI progress bars on the terminal.

example

var multimeter = require('multimeter');
var multi = multimeter(process);

multi.drop(function (bar) {
    var iv = setInterval(function () {
        var p = bar.percent();
        bar.percent(p + 1);
        
        if (p >= 100) clearInterval(iv);
    }, 25);
});

methods

var multimeter = require('multimeter');

var multi = multimeter(stream, ...)

Create a new multimeter handle on the supplied stream/process objects, which will be passed directly to charm.

If you pass in a charm object that will be used instead of creating a new one.

var bar = multi(x, y, params)

Create a new progress bar at (x,y) with params which default to:

• width : 10
• before : '['
• after : '] '
• solid : { background : 'blue', foreground : 'white', text : '|' }
• empty : { background : null, foreground : null, text : ' ' }

If y is negative or '-0' it will be treated as a relative coordinate.

var stack = multi(x, y, { type: 'stack', ... })

Accepts all parameters as a bar but returns a stack for pushing and popping text and bars:

var stack = multi(0, 1, {
  pad: true,
  type: 'stack',
  width : 20,
  solid : {
      text : '|',
      foreground : 'white',
      background : 'blue'
  },
  empty : { text : ' ' },
});

var dl1 = stack.push('download1', 'bar');
stack.push('Another download starting...');
var dl2 = stack.push('download2', 'bar');
dl2.percent(10);
// ...
dl2.percent(100);
stack.push('download2 is finished');
stack.splice('download2');

• pad: false,
• width : 10
• before : '['
• after : '] '
• solid : { background : 'blue', foreground : 'white', text : '|' }
• empty : { background : null, foreground : null, text : ' ' }

var bar = multi.rel(x, y, params)

Create a new progress bar at an absolute x and relative y coordinate with respect to the present multi.offset.

multi.drop(params, cb)

Create a new progress bar at the present cursor location. The bar object will be passed to cb(bar) once the cursor location has been determined.

multi.on(...), multi.removeListener(...), multi.destroy(...), multi.write(...)

Call event emitter functions on the underlying charm object.

multi.offset

This getter/setter controls the positioning for relative progress bars.

Increment this value whenever you write a newline to the stream to prevent the pending progress bars from drifting down from their original positions.

bar.percent(p, msg=p + ' %')

Update the progress bar to p percent, a value between 0 and 100, inclusive.

The text to the right of the progress bar will be set to msg.

bar.ratio(n, d, msg=n + ' / ' + d)

Update the progress bar with a ratio, n/d.

The text to the right of the progress bar will be set to msg.

stack.push(text, params)

Pushes the specified text onto the stack. If params is set will attempt to create a new Bar instance using the stack defaults if necessary. The text to the left of the progress bar will be set to text.

stack.splice(text)

Removes the line in the stack for the specified text

attributes

multi.charm

The charm object used internally to draw the progress bars.

install

With npm do:

npm install multimeter