A node module that you call during loops, to report on end.
Essentially, when your loop is finished, you get a report at the end counting warnings and errors.
There were 2 errors and 12 warnings while processing 2345 customers.
Most notably, I use this on streams, where the end event is not necessarily called when you have finished processing the data asynchronously.
##Install
Add as a dependency in your package.json file
"ender": "git://github.com/robjames/ender.git"Then npm install
##usage
ender returns a constructor;
var ender = require('ender');So you can create new instances like:
var customerEnder = new ender();The ender constructor can take 2 perameters: name and length; where length is the array length. Note, it is not requred to provide the length; you can increment it manually. See streams below.
var customerEnder = new ender('cusstomers', customerArray.length);There are some exposed methods that you can call.
var customerEnder = new ender('customers', someArray.length);
someArray.forEach(function(item, i, arr){
//do something long like saving to DB
item.save(function(err, item){
if (err) {
if (err.name === 'warning') {
customerEnder.incWarning();
} else {
customerEnder.incError();
}
}
//all ok
customerEnder.end(); //call end ALWAYS.
})
})When the loop has finished, you will get something like this in the console.log
There were 2 errors and 12 warnings while processing 3456 customers.
##Streams
On occasions you might not know the length of the data before being looped - like when importing a csv using streams (the origninal use of this module) - in this case you can manually increment the count, just before processing the action.
var customerEnder = new ender('customers');
...
...
.on('data', function(chunk){
customerEnder.incLength();
//do something long like saving to DB
chunk.save(function(err, item){
if (err) {
if (err.name === 'warning') {
customerEnder.incWarning();
} else {
customerEnder.incError();
}
return customerEnder.end();
}
//all ok
customerEnder.end(); //call end ALWAYS. (this means you also might need to include it in the error block)
})
})