# 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.
Async provides around 20 functions that include the usual 'functional'
suspects (map, reduce, filter, forEach…) 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
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'], path.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.
## Download
Releases are available for download from
[GitHub](http://github.com/caolan/async/downloads).
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) - 17.5kb Uncompressed
__Production:__ [async.min.js](https://github.com/caolan/async/raw/master/dist/async.min.js) - 1.7kb Packed and Gzipped
## In the Browser
So far its been tested in IE6, IE7, IE8, FF3.6 and Chrome 5. Usage:
<script type="text/javascript" src="async.js"></script>
<script type="text/javascript">
async.map(data, asyncProcess, function(err, results){
alert(results);
});
</script>
## Documentation
### Collections
* [forEach](#forEach)
* [map](#map)
* [filter](#filter)
* [reject](#reject)
* [reduce](#reduce)
* [detect](#detect)
* [sortBy](#sortBy)
* [some](#some)
* [every](#every)
* [concat](#concat)
### Control Flow
* [series](#series)
* [parallel](#parallel)
* [whilst](#whilst)
* [until](#until)
* [waterfall](#waterfall)
* [queue](#queue)
* [auto](#auto)
* [iterator](#iterator)
* [apply](#apply)
* [nextTick](#nextTick)
### Utils
* [memoize](#memoize)
* [unmemoize](#unmemoize)
* [log](#log)
* [dir](#dir)
* [noConflict](#noConflict)
## Collections
<a name="forEach" />
### forEach(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 forEach 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 which must be called once it has completed.
* callback(err) - A callback which is called after all the iterator functions
have finished, or an error has occurred.
__Example__
// assuming openFiles is an array of file names and saveFile is a function
// to save the modified contents of that file:
async.forEach(openFiles, saveFile, function(err){
// if any of the saves produced an error, err would equal that error
});
---------------------------------------
<a name="forEachSeries" />
### forEachSeries(arr, iterator, callback)
The same as forEach 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" />
### forEachLimit(arr, limit, iterator, callback)
The same as forEach only the iterator is applied to batches of items in the
array, in series. The next batch of iterators is only called once the current
one has completed processing.
__Arguments__
* arr - An array to iterate over.
* limit - How many items should be in each batch.
* iterator(item, callback) - A function to apply to each item in the array.
The iterator is passed a callback which must be called once it has completed.
* callback(err) - A callback which is called after all the iterator functions
have finished, or an error has occurred.
__Example__
// Assume documents is an array of JSON objects and requestApi is a
// function that interacts with a rate-limited REST api.
async.forEachLimit(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 which must be called once it has completed
with an error (which can be null) and a transformed item.
* callback(err, results) - A callback which is called after all the iterator
functions have finished, or an error has occurred. Results is an array of the
transformed items from the original array.
__Example__
async.map(['file1','file2','file3'], fs.stat, function(err, results){
// results is now an array of stats for each file
});
---------------------------------------
<a name="mapSeries" />
### mapSeries(arr, iterator, callback)
The same as map 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. The results array will be in the same order as the original.
---------------------------------------
<a name="filter" />
### filter(arr, iterator, callback)
__Alias:__ select
Returns a new array of all the values which pass an async truth test.
_The callback for each iterator call only accepts a single argument of true or
false, it does not accept an error argument first!_ This is in-line with the
way node libraries work with truth tests like path.exists. This operation is
performed in parallel, but the results array will be in the same order as the
original.
__Arguments__
* arr - An array to iterate over.
* iterator(item, callback) - A truth test to apply to each item in the array.
The iterator is passed a callback which must be called once it has completed.
* callback(results) - A callback which is called after all the iterator
functions have finished.
__Example__
async.filter(['file1','file2','file3'], path.exists, function(results){
// results now equals an array of the existing files
});
---------------------------------------
<a name="filterSeries" />
### filterSeries(arr, iterator, callback)
__alias:__ selectSeries
The same as filter 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. The results arra
没有合适的资源?快使用搜索试试~ 我知道了~
node-v0.10.4-darwin-x64.tar.gz
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 185 浏览量
2024-05-17
23:11:38
上传
评论
收藏 4.15MB GZ 举报
温馨提示
共949个文件
js:276个
md:157个
html:102个
node-v0.10.4-darwin-x64.tar
资源推荐
资源详情
资源评论
收起资源包目录
node-v0.10.4-darwin-x64.tar.gz (949个子文件)
config.1 24KB
json.1 21KB
node.1 19KB
set.1 18KB
get.1 18KB
faq.1 12KB
scripts.1 10KB
README.1 8KB
install.1 8KB
global.1 8KB
folders.1 8KB
shrinkwrap.1 7KB
developers.1 6KB
coding-style.1 6KB
npm.1 5KB
index.1 5KB
semver.1 5KB
disputes.1 5KB
registry.1 4KB
view.1 3KB
changelog.1 3KB
cache.1 2KB
ln.1 2KB
link.1 2KB
removing-npm.1 2KB
list.1 2KB
ls.1 2KB
version.1 2KB
dedupe.1 2KB
explore.1 1KB
owner.1 1KB
help.1 1KB
author.1 1KB
edit.1 1KB
submodule.1 1KB
help-search.1 1KB
bugs.1 1007B
home.1 1001B
docs.1 999B
adduser.1 969B
unpublish.1 967B
completion.1 954B
deprecate.1 927B
find.1 897B
publish.1 876B
init.1 874B
pack.1 859B
update.1 802B
star.1 662B
search.1 659B
restart.1 650B
stars.1 646B
build.1 632B
prune.1 621B
run-script.1 619B
rebuild.1 596B
test.1 560B
outdated.1 502B
bundle.1 497B
tag.1 486B
rm.1 483B
uninstall.1 483B
start.1 476B
stop.1 472B
root.1 434B
bin.1 428B
prefix.1 407B
whoami.1 374B
view.3 4KB
npm.3 4KB
ls.3 2KB
list.3 2KB
find.3 2KB
search.3 1KB
get.3 1KB
set.3 1KB
config.3 1KB
author.3 1KB
owner.3 1KB
ln.3 1KB
link.3 1KB
help-search.3 1KB
init.3 1KB
submodule.3 1KB
deprecate.3 1KB
run-script.3 1022B
publish.3 991B
edit.3 969B
tag.3 968B
load.3 849B
shrinkwrap.3 801B
explore.3 800B
commands.3 791B
pack.3 747B
install.3 745B
unpublish.3 735B
home.3 715B
version.3 714B
docs.3 713B
bugs.3 711B
共 949 条
- 1
- 2
- 3
- 4
- 5
- 6
- 10
资源评论
程序员Chino的日记
- 粉丝: 2991
- 资源: 4万+
下载权益
C知道特权
VIP文章
课程特权
开通VIP
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功