async-process

0.0.1 • Public • Published

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.

Param Type Description
tasks Array An array of data. Each entry will be processed async.
taskCallback taskCallback function that will be called for each value in the tasks. the value as the first parameter and the callback as the second one.
onFinish function The 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

Param Type Description
err Object The error that occured.
name string | number | null The 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

Param Type Description
value any The value to be processed
callback asyncProcess.onError | function The callback when the task is completed

Package Sidebar

Install

npm i async-process

Weekly Downloads

1

Version

0.0.1

License

GPL-3.0

Last publish

Collaborators

  • popojargo