callbacks-helper-tiny v0.3.0

callbacks-helper-tiny

callbacks-helper-tiny is a tiny library on Typescript (and JavaScript) which help to wait for multiple callbacks to finish.

Install

npm i callbacks-helper-tiny

Functions

cbWaitAll(arrayOfCallbacks, callback) - call all callbacks in arrayOfCallbacks. When all callbacks are done call callback.

cbWaitAllWithData(arrayOfCallbacks, callback) - call all callbacks in arrayOfCallbacks. When all callbacks are done call callback.

clbQueue(arrayOfCallbacks, callback) - call callbacks in arrayOfCallbacks one after the other then call callback.

cbQueueWithData(arrayOfCallbacks, callback) - call callbacks in arrayOfCallbacks one after the other then call callback.

Usage

JavaScript

const cbWaitAll         = require('callbacks-helper-tiny').cbWaitAll;
const cbWaitAllWithData = require('callbacks-helper-tiny').cbWaitAllWithData;
const clbQueue          = require('callbacks-helper-tiny').clbQueue;
const cbQueueWithData   = require('callbacks-helper-tiny').cbQueueWithData;


// short example
let callbacksQueue = [];
let i;

for (i=0; i<8; i++) {
    callbacksQueue.push(function(clb) {
        ajax(data,
            function() { // success
                clb(null);
            },
            function() { // error
                clb(new Error('ajax error'));
            }
        );
    });
}

clbQueue(callbacksQueue, function(err) {
    if (err) {
        console.log(err);
    }
    else {
        console.log('success');
    }
});


// another example
cbQueueWithData([
        function(clb) { // wrapper
            setTimeout( function() { // your callback
                clb(null, 42); // clb( Error, customDataIfNeeded)
            }, 1000);
        },
        function(clb) { // one more
            setTimeout( function() { // your callback
                clb(new Error("Oh!!")); // Error :(
            }, 1000);
        },
        function(clb) {
            setTimeout( function() { // your callback
                clb(null, { key: 'value'});
            }, 1000);
        },
    ],
    function(err, results) { // when all callbacks done or error exists
        if (err) {
            console.log(err);
        }
        else {
            // results from callbacks array
            console.log(results);
        }
});


cbWaitAllWithData([
        function(clb) { // wrapper
            setTimeout( function() { // your callback
                clb(null, 42); // clb( Error, customDataIfNeeded)
            }, 1000);
        },
        function(clb) { // one more
            setTimeout( function() { // your callback
                clb(new Error("Oh!!")); // Error :(
            }, 1000);
        },
        function(clb) {
            setTimeout( function() { // your callback
                clb(null, { key: 'value'});
            }, 1000);
        },
    ],
    function(err, data) { // when all callbacks done or error exists
        if (err) {
            console.log(err);
        }
        else {
            console.log(data);
        }
});

License

MIT