README.md

asyncjs-promise

Simple async methods with promise support.

Installation

Installation is done using the npm install command:

$ npm install --save asyncjs-promise

Upgrade from v0.x.x to v1.x.x

In v1.0.0, custom functions have been added which cause previous code executions to no longer work.
The function itself has not changed.

Regarding this, the module was also renamed to asyncjs-promise.

Previous:

const forEach = require("asyncforeach-promise");

const array = [34, 24, 54];
forEach(array, (element, index, next) => {
    console.log(element);
    next()
})
.then(() => {
    console.log("finished");
})
.catch(console.error);

Now:

const async = require("asyncjs-promise");

const array = [34, 24, 54];
async.each(array, (element, index, next) => {
    console.log(element);

    return next();
})
.then(() => {
    console.log("finished");
})
.catch(console.error);

Usage

.each(arrayOrIterableElement, callbackFunction)

Example:

const async = require("asyncjs-promise");

const array = [34, 24, 54];
async.each(array, (element, index, next) => {
    console.log(element);

    return next();
})
.then(() => {
    console.log("finished");
})
.catch(console.error);

Output:

34
24
54
finished

This will be super useful if you try to interact with a database or a web API and try to process a set of data. A normal forEach would end up in multiple parallel executing tasks, ...

---

.until(conditionFunction, callbackFunction)

Example:

const async = require("asyncjs-promise");

let counter = 0;
async.until(() => counter >= 5), next => {
    counter++;
    console.log(counter);

    return next();
})
.then(() => {
    console.log("finished");
})
.catch(console.error);

Output:

1
2
3
4
5
finished

This will be super useful if you try to interact with a database or a web API and try to get an undefined length of data. A normal while would end up in multiple parallel executing tasks, ...

---

.retry(callbackFunction[, limit, delay, retryCallback])

Examples:

Minimal example:

const async = require("asyncjs-promise");

async.retry(() => {
    // ... async function which returns a promise
})
.then(() => {
    console.log("finished");
})
.catch(console.error);

Retry the function a second time.

Advanced example:

const async = require("asyncjs-promise");

async.retry(() => {
    // ... async function which returns a promise
}, 5, 250, (retry, error) => {
    console.log(retry);
    console.error(error);
})
.then(() => {
    console.log("finished");
})
.catch(console.error);

Output:

4
*error*
3
*error*
2
*error*
1
*error*
0
*error*

Retries the function up to 5 times, with a delay of 250ms between. The retryCallback will be triggered after each retry.

---

License

MIT