1 | ![Async Logo](https://raw.githubusercontent.com/caolan/async/master/logo/async-logo_readme.jpg)
|
---|
2 |
|
---|
3 | [![Build Status via Travis CI](https://travis-ci.org/caolan/async.svg?branch=master)](https://travis-ci.org/caolan/async)
|
---|
4 | [![NPM version](https://img.shields.io/npm/v/async.svg)](https://www.npmjs.com/package/async)
|
---|
5 | [![Coverage Status](https://coveralls.io/repos/caolan/async/badge.svg?branch=master)](https://coveralls.io/r/caolan/async?branch=master)
|
---|
6 | [![Join the chat at https://gitter.im/caolan/async](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/caolan/async?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
---|
7 | [![libhive - Open source examples](https://www.libhive.com/providers/npm/packages/async/examples/badge.svg)](https://www.libhive.com/providers/npm/packages/async)
|
---|
8 | [![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/async/badge?style=rounded)](https://www.jsdelivr.com/package/npm/async)
|
---|
9 |
|
---|
10 |
|
---|
11 | Async is a utility module which provides straight-forward, powerful functions for working with [asynchronous JavaScript](http://caolan.github.io/async/global.html). Although originally designed for use with [Node.js](https://nodejs.org/) and installable via `npm install --save async`, it can also be used directly in the browser.
|
---|
12 |
|
---|
13 | This version of the package is optimized for the Node.js environment. If you use Async with webpack, install [`async-es`](https://www.npmjs.com/package/async-es) instead.
|
---|
14 |
|
---|
15 | For Documentation, visit <https://caolan.github.io/async/>
|
---|
16 |
|
---|
17 | *For Async v1.5.x documentation, go [HERE](https://github.com/caolan/async/blob/v1.5.2/README.md)*
|
---|
18 |
|
---|
19 |
|
---|
20 | ```javascript
|
---|
21 | // for use with Node-style callbacks...
|
---|
22 | var async = require("async");
|
---|
23 |
|
---|
24 | var obj = {dev: "/dev.json", test: "/test.json", prod: "/prod.json"};
|
---|
25 | var configs = {};
|
---|
26 |
|
---|
27 | async.forEachOf(obj, (value, key, callback) => {
|
---|
28 | fs.readFile(__dirname + value, "utf8", (err, data) => {
|
---|
29 | if (err) return callback(err);
|
---|
30 | try {
|
---|
31 | configs[key] = JSON.parse(data);
|
---|
32 | } catch (e) {
|
---|
33 | return callback(e);
|
---|
34 | }
|
---|
35 | callback();
|
---|
36 | });
|
---|
37 | }, err => {
|
---|
38 | if (err) console.error(err.message);
|
---|
39 | // configs is now a map of JSON data
|
---|
40 | doSomethingWith(configs);
|
---|
41 | });
|
---|
42 | ```
|
---|
43 |
|
---|
44 | ```javascript
|
---|
45 | var async = require("async");
|
---|
46 |
|
---|
47 | // ...or ES2017 async functions
|
---|
48 | async.mapLimit(urls, 5, async function(url) {
|
---|
49 | const response = await fetch(url)
|
---|
50 | return response.body
|
---|
51 | }, (err, results) => {
|
---|
52 | if (err) throw err
|
---|
53 | // results is now an array of the response bodies
|
---|
54 | console.log(results)
|
---|
55 | })
|
---|
56 | ```
|
---|