summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Early <alexander.early@gmail.com>2015-07-16 17:17:03 -0700
committerAlexander Early <alexander.early@gmail.com>2015-07-16 17:17:03 -0700
commit0ae73898f30f408a016d56342684553a7af5d038 (patch)
treee2b5327b8e28c68559304d2b9d4c40c84fe3f001
parentbb21b4ad61dacad5393df894ea5f2add7a8937b3 (diff)
parent09ac18aa6cfdf86474ce51508a534411b7ff7a9c (diff)
downloadasync-0ae73898f30f408a016d56342684553a7af5d038.tar.gz
Merge pull request #848 from charlierudolph/cr-updateReadme
update readme
-rw-r--r--README.md41
1 files changed, 14 insertions, 27 deletions
diff --git a/README.md b/README.md
index 4ad483d..e0c48ad 100644
--- a/README.md
+++ b/README.md
@@ -103,7 +103,7 @@ async.waterfall([
callback(new Error("failed getting something:" + err.message));
// we should return here
}
- // since we did not return, this callback still will be called and
+ // since we did not return, this callback still will be called and
// `processData` will be called twice
callback(result);
});
@@ -191,16 +191,14 @@ Some functions are also available in the following forms:
* [`each`](#each), `eachSeries`, `eachLimit`
* [`forEachOf`](#forEachOf), `forEachOfSeries`, `forEachOfLimit`
* [`map`](#map), `mapSeries`, `mapLimit`
-* [`filter`](#filter), `filterSeries`
-* [`reject`](#reject), `rejectSeries`
+* [`filter`](#filter), `filterSeries`, `filterLimit`
+* [`reject`](#reject), `rejectSeries`, `rejectLimit`
* [`reduce`](#reduce), [`reduceRight`](#reduceRight)
* [`detect`](#detect), `detectSeries`
* [`sortBy`](#sortBy)
-* [`some`](#some)
-* [`someLimit`](#someLimit)
-* [`every`](#every)
-* [`concat`](#concat)
-* [`concatSeries`](#concatSeries)
+* [`some`](#some), `someLimit`
+* [`every`](#every), `everyLimit`
+* [`concat`](#concat), `concatSeries`
### Control Flow
@@ -424,6 +422,7 @@ async.filter(['file1','file2','file3'], fs.exists, function(results){
__Related__
* filterSeries(arr, iterator, [callback])
+* filterLimit(arr, iterator, [callback])
---------------------------------------
@@ -435,6 +434,7 @@ The opposite of [`filter`](#filter). Removes values that pass an `async` truth t
__Related__
* rejectSeries(arr, iterator, [callback])
+* rejectLimit(arr, iterator, [callback])
---------------------------------------
@@ -606,26 +606,9 @@ async.some(['file1','file2','file3'], fs.exists, function(result){
});
```
----------------------------------------
-
-<a name="someLimit" />
-### someLimit(arr, limit, iterator, callback)
-
-__Alias:__ `anyLimit`
-
-The same as [`some`](#some), only no more than `limit` `iterator`s will be simultaneously
-running at any time.
+__Related__
-__Arguments__
-
-* `arr` - An array to iterate over.
-* `limit` - The maximum number of `iterator`s to run at any time.
-* `iterator(item, callback)` - A truth test to apply to each item in the array
- in parallel. The iterator is passed a callback(truthValue) which must be
- called with a boolean argument once it has completed.
-* `callback(result)` - A callback which is called as soon as any iterator returns
- `true`, or after all the iterator functions have finished. Result will be
- either `true` or `false` depending on the values of the async tests.
+* someLimit(arr, limit, iterator, callback)
---------------------------------------
@@ -659,6 +642,10 @@ async.every(['file1','file2','file3'], fs.exists, function(result){
});
```
+__Related__
+
+* everyLimit(arr, limit, iterator, callback)
+
---------------------------------------
<a name="concat" />