tqdm v2.0.3

tqdm

tqdm for node

Wrap an iterable in tdqm, and it will render the progress bar to stdout as it iterates.

Installation:

npm install tqdm

Usage:

const tdqm = require(`tqdm`);

const array = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
for(let i of tdqm(array))
	// long calculations...

For infinite iterables, you need to specify a total number of iteations to complete. If no total is specified, tdqm will render appropriate indefinite progress bar:

for(let i of tdqm(generator(), {total: 50}))
	// long calculations...

This version also supports async generators:

for await (let i of tdqm(asyncGenerator(), {total: 50}))
	// long calculations...

Normally, tdqm updates the same line, and assumes nothing else is written to stdout, you can set sameLine option to false to suppress this behaviour:

for(let i of tdqm(generator(), {total: 50, sameLine: true})) {
	// long calculations...
	console.log("Did something");
}

Options to pass to tqdm:

• total — number of iterations before halting;
• sameLine — boolean, outputs progress bar on the same line if true;
• minIter — the minimum number of iterations between progress bar renders;
• minInterval — the minimal interval of time between progress bar renders;
• render — custom render function, accepts arguments: n — number of completed iterations; total — number of iterations to complete, null if infinite range; * elapsed — elapsed time in millyseconds.