async-for-each

Asynchronous array iteration

async-for-each exposes a function to iterate over an array asynchronously. This is useful for iteration that must occur in an asynchronous context, or for iterating over long arrays without blocking the event loop.

Installation

npm install --save async-for-each

Usage

const asyncForEach = require("async-for-each");
    
const arr = [1, 2, 3, 4, 5];
asyncForEach(arr, function(value, index, next) {
    console.log("The value at %s is %s", index, value);
    doSomethingAsyncWithValue(value, function() {
        next();
    });
}, function() {
    console.log("Iteration complete!");
});

API

Functions

Typedefs

asyncForEach(array, iterator, callback)

Iterates over an array asynchronously.

Kind: global function

| Param | Type | Description | | --- | --- | --- | | array | Array | The array over which to iterate. | | iterator | iteratorCallback | The iterator function. Called with the signature iterator(value, index, next), where value is the current array value, index is the current index, and next is a function to be called when the next iteration should occur. IMPORTANT: if next() is never called in the iterator function, the iteration will never complete. | | callback | finalCallback | The callback function. Called with the signature callback(error) when the iteration is complete. |

iteratorCallback : function

The asyncForEach iterator callback.

Kind: global typedef

| Param | Type | Description | | --- | --- | --- | | value | * | The value currently being iterated over. | | index | number | The index currently being iterated over | | next | function | Called to indicate that the current iteration is over. |

finalCallback : function

The asyncForEach final callback.

Kind: global typedef

| Param | Type | Description | | --- | --- | --- | | error | Error | Error that was raised during iteration, if any. |