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 = ;var fs = ;var loadedData = {};var filesToLoad = "./example/file1.json" "./example/file2.json" "./example/file3.json";var { fs;}; filesToLoad filesCb { //At this point all the files are loaded console; console; thistasksFails};
Documentation
- asyncProcess
- new asyncProcess(tasks, taskCallback, onFinish)
- instance
- static
- .taskCallback :
function
- .taskCallback :
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 |
Array
asyncProcess.tasksFails : 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
function
asyncProcess.taskCallback : 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 |