# Async.js
Async is a utility module which provides straight-forward, powerful functions
for working with asynchronous JavaScript. Although originally designed for
use with [node.js](http://nodejs.org), it can also be used directly in the
browser. Also supports [component](https://github.com/component/component).
Async provides around 20 functions that include the usual 'functional'
suspects (map, reduce, filter, each…) as well as some common patterns
for asynchronous control flow (parallel, series, waterfall…). All these
functions assume you follow the node.js convention of providing a single
callback as the last argument of your async function.
## Quick Examples
```javascript
async.map(['file1','file2','file3'], fs.stat, function(err, results){
// results is now an array of stats for each file
});
async.filter(['file1','file2','file3'], fs.exists, function(results){
// results now equals an array of the existing files
});
async.parallel([
function(){ ... },
function(){ ... }
], callback);
async.series([
function(){ ... },
function(){ ... }
]);
```
There are many more functions available so take a look at the docs below for a
full list. This module aims to be comprehensive, so if you feel anything is
missing please create a GitHub issue for it.
## Common Pitfalls
### Binding a context to an iterator
This section is really about bind, not about async. If you are wondering how to
make async execute your iterators in a given context, or are confused as to why
a method of another library isn't working as an iterator, study this example:
```js
// Here is a simple object with an (unnecessarily roundabout) squaring method
var AsyncSquaringLibrary = {
squareExponent: 2,
square: function(number, callback){
var result = Math.pow(number, this.squareExponent);
setTimeout(function(){
callback(null, result);
}, 200);
}
};
async.map([1, 2, 3], AsyncSquaringLibrary.square, function(err, result){
// result is [NaN, NaN, NaN]
// This fails because the `this.squareExponent` expression in the square
// function is not evaluated in the context of AsyncSquaringLibrary, and is
// therefore undefined.
});
async.map([1, 2, 3], AsyncSquaringLibrary.square.bind(AsyncSquaringLibrary), function(err, result){
// result is [1, 4, 9]
// With the help of bind we can attach a context to the iterator before
// passing it to async. Now the square function will be executed in its
// 'home' AsyncSquaringLibrary context and the value of `this.squareExponent`
// will be as expected.
});
```
## Download
The source is available for download from
[GitHub](http://github.com/caolan/async).
Alternatively, you can install using Node Package Manager (npm):
npm install async
__Development:__ [async.js](https://github.com/caolan/async/raw/master/lib/async.js) - 29.6kb Uncompressed
## In the Browser
So far it's been tested in IE6, IE7, IE8, FF3.6 and Chrome 5. Usage:
```html
<script type="text/javascript" src="async.js"></script>
<script type="text/javascript">
async.map(data, asyncProcess, function(err, results){
alert(results);
});
</script>
```
## Documentation
### Collections
* [each](#each)
* [eachSeries](#eachSeries)
* [eachLimit](#eachLimit)
* [map](#map)
* [mapSeries](#mapSeries)
* [mapLimit](#mapLimit)
* [filter](#filter)
* [filterSeries](#filterSeries)
* [reject](#reject)
* [rejectSeries](#rejectSeries)
* [reduce](#reduce)
* [reduceRight](#reduceRight)
* [detect](#detect)
* [detectSeries](#detectSeries)
* [sortBy](#sortBy)
* [some](#some)
* [every](#every)
* [concat](#concat)
* [concatSeries](#concatSeries)
### Control Flow
* [series](#series)
* [parallel](#parallel)
* [parallelLimit](#parallellimittasks-limit-callback)
* [whilst](#whilst)
* [doWhilst](#doWhilst)
* [until](#until)
* [doUntil](#doUntil)
* [forever](#forever)
* [waterfall](#waterfall)
* [compose](#compose)
* [applyEach](#applyEach)
* [applyEachSeries](#applyEachSeries)
* [queue](#queue)
* [cargo](#cargo)
* [auto](#auto)
* [iterator](#iterator)
* [apply](#apply)
* [nextTick](#nextTick)
* [times](#times)
* [timesSeries](#timesSeries)
### Utils
* [memoize](#memoize)
* [unmemoize](#unmemoize)
* [log](#log)
* [dir](#dir)
* [noConflict](#noConflict)
## Collections
<a name="forEach" />
<a name="each" />
### each(arr, iterator, callback)
Applies an iterator function to each item in an array, in parallel.
The iterator is called with an item from the list and a callback for when it
has finished. If the iterator passes an error to this callback, the main
callback for the each function is immediately called with the error.
Note, that since this function applies the iterator to each item in parallel
there is no guarantee that the iterator functions will complete in order.
__Arguments__
* arr - An array to iterate over.
* iterator(item, callback) - A function to apply to each item in the array.
The iterator is passed a callback(err) which must be called once it has
completed. If no error has occured, the callback should be run without
arguments or with an explicit null argument.
* callback(err) - A callback which is called after all the iterator functions
have finished, or an error has occurred.
__Example__
```js
// assuming openFiles is an array of file names and saveFile is a function
// to save the modified contents of that file:
async.each(openFiles, saveFile, function(err){
// if any of the saves produced an error, err would equal that error
});
```
---------------------------------------
<a name="forEachSeries" />
<a name="eachSeries" />
### eachSeries(arr, iterator, callback)
The same as each only the iterator is applied to each item in the array in
series. The next iterator is only called once the current one has completed
processing. This means the iterator functions will complete in order.
---------------------------------------
<a name="forEachLimit" />
<a name="eachLimit" />
### eachLimit(arr, limit, iterator, callback)
The same as each only no more than "limit" iterators will be simultaneously
running at any time.
Note that the items are not processed in batches, so there is no guarantee that
the first "limit" iterator functions will complete before any others are
started.
__Arguments__
* arr - An array to iterate over.
* limit - The maximum number of iterators to run at any time.
* iterator(item, callback) - A function to apply to each item in the array.
The iterator is passed a callback(err) which must be called once it has
completed. If no error has occured, the callback should be run without
arguments or with an explicit null argument.
* callback(err) - A callback which is called after all the iterator functions
have finished, or an error has occurred.
__Example__
```js
// Assume documents is an array of JSON objects and requestApi is a
// function that interacts with a rate-limited REST api.
async.eachLimit(documents, 20, requestApi, function(err){
// if any of the saves produced an error, err would equal that error
});
```
---------------------------------------
<a name="map" />
### map(arr, iterator, callback)
Produces a new array of values by mapping each value in the given array through
the iterator function. The iterator is called with an item from the array and a
callback for when it has finished processing. The callback takes 2 arguments,
an error and the transformed item from the array. If the iterator passes an
error to this callback, the main callback for the map function is immediately
called with the error.
Note, that since this function applies the iterator to each item in parallel
there is no guarantee that the iterator functions will complete in order, however
the results array will be in the same order as the original array.
__Arguments__
* arr - An array to iterate over.
* iterator(item, callback) - A function to apply to each item in the array.
The iterator is passed a callback(err, transformed) which must be called onc
程皮
- 粉丝: 279
- 资源: 2568
最新资源
- 基于统一迭代法的交直流潮流计算程序-通用性强,注释齐全,易于理解,可调整节点数量,交直流潮流计算程序matlab 通过统一迭代法实现,程序注释齐全,方便理解,通用性强,可根据需要改成相应的节点数量
- 基于STM32的温度范围从-200℃到600℃的PT100(RTD)三线制测量系统方案,液晶显示及超量程报警功能,带串口下载电路的快速原型参考设计 ,PT100(RTD)三线制测量方案 本方案仅为开发
- 昆仑通态触摸屏与台达VFD-M系列变频器通讯编程实现操作手册:频率设定、启停等功能及参数设置指南,昆仑通态触摸屏与台达VFD-M系列变频通讯程序,可实现频率设定,启停等功能 可以附带提供变频器说明书
- 内置式一字型永磁同步电机设计案例:高效潜水泵应用,低转矩脉动与稳定直流电压输出,超精密驱动体验,内置式“一字型”900W,3000RPM,8极12槽永磁同步电机(PMSM)设计案例(潜水泵用),直径1
- 基于等精度测量的数字频率计仿真工程详解:从设计到测试手把手教学,可测量频率范围覆盖至Hz至MHz级,基于等精度测量的数字频率计仿真工程 本设计按照等精度测量原理,设计三个模块,分别是闸门时间模块,计数
- 内置式V字型永磁同步电机(PMSM)设计案例解析:直径210mm,叠高150mm,45KW功率,4200RPM转速,8极48槽基于MotorCAD建模,基于MotorCAD(Maxwell模型也有)的
- 电商前台商城原型模板全面解析 #Axure实战教程# 涵盖订单、库存等核心模块,助力产品人专注产品设计,适合互联网产品经理与学习者的专业参考工具 ,电商前台商城原型模板 #产品原型#Axure# 文件
- Delphi 12 控件之beyond-compare-5.0.5.30614.zip
- Delphi 12 控件之BC5-keygen.zip
- 电商客户端原型模板 #Axure必备#:首页、分类等核心模块全解析,助力产品经理专注产品设计,电商客户端原型模板 #产品原型#Axure# 文件大小8.4M,涵盖客户端常见核心模块:首页、分类、专题
- Delphi 12 控件之Basic.skinres
- 冷漠新赛季全网第一文件.zip
- CRM后台原型模板:包含12大核心模块的产品原型设计,助力产品经理专注产品本质,Axure研究学习价值高,CRM后台原型模板 #产品原型#Axure# 文件大小6.21M,系统业务分为12个核心模块:
- 经典案例:6极36槽V型磁钢永磁同步电机(PMSM)-高效稳定,高过载能力设计案例,经典22kW,外径290 轴向长度88 3000RPM,72Nm, 6极36槽永磁同步电机(PMSM)设计案例
- 基于Harris角点与单映变换的Matlab图像拼接GUI软件介绍:五大模块,高效拼接,学习参考使用,Matlab 图像拼接GUI 图像拼接基于Harris角点、SHIFT匹配、RANSAC匹配对优化
- 【附源码】如何制作一款属于自己的勒索病毒(AES文件加解密)(上).mp4
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈