0.0.1 • Published 7 years ago

async-process v0.0.1

Weekly downloads
2
License
GPL-3.0
Repository
github
Last release
7 years ago

async-process

A minimalist Node.js module that let you perform multiples async tasks. Once they are completed, you can call a callback function.

##Example

To run the example, simply run the npm run example in the root directory.

Example :

var asyncProcess = require("async-process");
var fs = require("fs");
var loadedData = {};
var filesToLoad = ["./example/file1.json", "./example/file2.json", "./example/file3.json"];
var filesCb = function (val, cb) {
    fs.readFile(val, function (err, data) {
            if (!err)
                loadedData[val] = data;
            cb(err,val); //Pass null if not error.
        }
    );
};

new asyncProcess(filesToLoad, filesCb, function () {
    //At this point all the files are loaded
    console.log("All files have been processed");
    console.log("\nFile 3 should fail.");
    this.tasksFails.forEach(function(id){
        console.warn("Task : "+id+" failed.");
    })
});

#Documentation

new asyncProcess(tasks, taskCallback, onFinish)

Object used to handle async process.

ParamTypeDescription
tasksArrayAn array of data. Each entry will be processed async.
taskCallbacktaskCallbackfunction that will be called for each value in the tasks. the value as the first parameter and the callback as the second one.
onFinishfunctionThe finish callback function

asyncProcess.tasksFails : Array

Kind: instance property of asyncProcess
Access: public

asyncProcess.onFinish()

Default onFinish function called after the tasks are completed.

Kind: instance method of asyncProcess

asyncProcess.onError(err, name)

The callback called when the task is processed and failed

Kind: instance method of asyncProcess

ParamTypeDescription
errObjectThe error that occured.
namestring | number | nullThe name of the task. Can be useful to debug.

asyncProcess.onTaskFinish()

Function that need to be called after every task is done.

Kind: instance method of asyncProcess

asyncProcess.taskCallback : function

The callback called for every task supplied.

Kind: static typedef of asyncProcess

ParamTypeDescription
valueanyThe value to be processed
callbackasyncProcess.onError | functionThe callback when the task is completed