summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Early <alexander.early@gmail.com>2020-02-23 17:55:47 -0800
committerAlexander Early <alexander.early@gmail.com>2020-02-23 17:55:56 -0800
commit08f1b4deb383ab6bfd2c27214f21c4a5b1481a71 (patch)
treed1bda648175b7f8b9520bb46e90fc9035058f559
parent686443ea93179ddaccb96b6dcb11c7ebe38d34d4 (diff)
downloadasync-08f1b4deb383ab6bfd2c27214f21c4a5b1481a71.tar.gz
regenerate docs
-rw-r--r--docs/v3/apply.js.html4
-rw-r--r--docs/v3/applyEach.js.html4
-rw-r--r--docs/v3/applyEachSeries.js.html4
-rw-r--r--docs/v3/asyncify.js.html4
-rw-r--r--docs/v3/auto.js.html4
-rw-r--r--docs/v3/autoInject.js.html8
-rw-r--r--docs/v3/cargo.js.html4
-rw-r--r--docs/v3/cargoQueue.js.html4
-rw-r--r--docs/v3/compose.js.html4
-rw-r--r--docs/v3/concat.js.html4
-rw-r--r--docs/v3/concatLimit.js.html4
-rw-r--r--docs/v3/concatSeries.js.html4
-rw-r--r--docs/v3/constant.js.html4
-rw-r--r--docs/v3/detect.js.html4
-rw-r--r--docs/v3/detectLimit.js.html4
-rw-r--r--docs/v3/detectSeries.js.html4
-rw-r--r--docs/v3/dir.js.html4
-rw-r--r--docs/v3/doUntil.js.html4
-rw-r--r--docs/v3/doWhilst.js.html4
-rw-r--r--docs/v3/docs.html368
-rw-r--r--docs/v3/each.js.html4
-rw-r--r--docs/v3/eachLimit.js.html4
-rw-r--r--docs/v3/eachOf.js.html4
-rw-r--r--docs/v3/eachOfLimit.js.html4
-rw-r--r--docs/v3/eachOfSeries.js.html4
-rw-r--r--docs/v3/eachSeries.js.html4
-rw-r--r--docs/v3/ensureAsync.js.html4
-rw-r--r--docs/v3/every.js.html4
-rw-r--r--docs/v3/everyLimit.js.html4
-rw-r--r--docs/v3/everySeries.js.html4
-rw-r--r--docs/v3/filter.js.html4
-rw-r--r--docs/v3/filterLimit.js.html4
-rw-r--r--docs/v3/filterSeries.js.html4
-rwxr-xr-x[-rw-r--r--]docs/v3/fonts/OpenSans-Semibold-webfont.eotbin20028 -> 20028 bytes
-rwxr-xr-x[-rw-r--r--]docs/v3/fonts/OpenSans-Semibold-webfont.svg0
-rwxr-xr-x[-rw-r--r--]docs/v3/fonts/OpenSans-Semibold-webfont.ttfbin39476 -> 39476 bytes
-rwxr-xr-x[-rw-r--r--]docs/v3/fonts/OpenSans-Semibold-webfont.woffbin22908 -> 22908 bytes
-rwxr-xr-x[-rw-r--r--]docs/v3/fonts/OpenSans-SemiboldItalic-webfont.eotbin20962 -> 20962 bytes
-rwxr-xr-x[-rw-r--r--]docs/v3/fonts/OpenSans-SemiboldItalic-webfont.svg0
-rwxr-xr-x[-rw-r--r--]docs/v3/fonts/OpenSans-SemiboldItalic-webfont.ttfbin40252 -> 40252 bytes
-rwxr-xr-x[-rw-r--r--]docs/v3/fonts/OpenSans-SemiboldItalic-webfont.woffbin23764 -> 23764 bytes
-rw-r--r--docs/v3/forever.js.html4
-rw-r--r--docs/v3/global.html4
-rw-r--r--docs/v3/groupBy.js.html4
-rw-r--r--docs/v3/groupByLimit.js.html4
-rw-r--r--docs/v3/groupBySeries.js.html4
-rw-r--r--docs/v3/index.html104
-rw-r--r--docs/v3/index.js.html4
-rw-r--r--docs/v3/log.js.html4
-rw-r--r--docs/v3/map.js.html4
-rw-r--r--docs/v3/mapLimit.js.html4
-rw-r--r--docs/v3/mapSeries.js.html4
-rw-r--r--docs/v3/mapValues.js.html4
-rw-r--r--docs/v3/mapValuesLimit.js.html4
-rw-r--r--docs/v3/mapValuesSeries.js.html4
-rw-r--r--docs/v3/memoize.js.html4
-rw-r--r--docs/v3/module-Collections.html152
-rw-r--r--docs/v3/module-ControlFlow.html168
-rw-r--r--docs/v3/module-Utils.html56
-rw-r--r--docs/v3/module-async.html4
-rw-r--r--docs/v3/nextTick.js.html6
-rw-r--r--docs/v3/parallel.js.html4
-rw-r--r--docs/v3/parallelLimit.js.html4
-rw-r--r--docs/v3/priorityQueue.js.html4
-rw-r--r--docs/v3/queue.js.html12
-rw-r--r--docs/v3/race.js.html4
-rw-r--r--docs/v3/reduce.js.html4
-rw-r--r--docs/v3/reduceRight.js.html4
-rw-r--r--docs/v3/reflect.js.html4
-rw-r--r--docs/v3/reflectAll.js.html4
-rw-r--r--docs/v3/reject.js.html4
-rw-r--r--docs/v3/rejectLimit.js.html4
-rw-r--r--docs/v3/rejectSeries.js.html4
-rw-r--r--docs/v3/retry.js.html4
-rw-r--r--docs/v3/retryable.js.html4
-rw-r--r--docs/v3/scripts/async.js111
-rw-r--r--docs/v3/seq.js.html4
-rw-r--r--docs/v3/series.js.html4
-rw-r--r--docs/v3/setImmediate.js.html4
-rw-r--r--docs/v3/some.js.html4
-rw-r--r--docs/v3/someLimit.js.html4
-rw-r--r--docs/v3/someSeries.js.html4
-rw-r--r--docs/v3/sortBy.js.html4
-rw-r--r--docs/v3/timeout.js.html4
-rw-r--r--docs/v3/times.js.html4
-rw-r--r--docs/v3/timesLimit.js.html4
-rw-r--r--docs/v3/timesSeries.js.html4
-rw-r--r--docs/v3/transform.js.html4
-rw-r--r--docs/v3/tryEach.js.html4
-rw-r--r--docs/v3/unmemoize.js.html4
-rw-r--r--docs/v3/until.js.html4
-rw-r--r--docs/v3/waterfall.js.html4
-rw-r--r--docs/v3/whilst.js.html4
93 files changed, 886 insertions, 403 deletions
diff --git a/docs/v3/apply.js.html b/docs/v3/apply.js.html
index 4a640a5..1f505ed 100644
--- a/docs/v3/apply.js.html
+++ b/docs/v3/apply.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -131,7 +131,7 @@ export default function(fn, ...args) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/applyEach.js.html b/docs/v3/applyEach.js.html
index 15dbe22..12461f1 100644
--- a/docs/v3/applyEach.js.html
+++ b/docs/v3/applyEach.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -126,7 +126,7 @@ export default applyEach(map);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/applyEachSeries.js.html b/docs/v3/applyEachSeries.js.html
index d946090..8bebb97 100644
--- a/docs/v3/applyEachSeries.js.html
+++ b/docs/v3/applyEachSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -106,7 +106,7 @@ export default applyEach(mapSeries);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/asyncify.js.html b/docs/v3/asyncify.js.html
index 293f450..5892c7e 100644
--- a/docs/v3/asyncify.js.html
+++ b/docs/v3/asyncify.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -183,7 +183,7 @@ function invokeCallback(callback, error, value) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/auto.js.html b/docs/v3/auto.js.html
index e4239a8..ccf3cf8 100644
--- a/docs/v3/auto.js.html
+++ b/docs/v3/auto.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -338,7 +338,7 @@ export default function auto(tasks, concurrency, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/autoInject.js.html b/docs/v3/autoInject.js.html
index 8a3cfa5..66c6502 100644
--- a/docs/v3/autoInject.js.html
+++ b/docs/v3/autoInject.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -79,8 +79,8 @@
import wrapAsync from &apos;./internal/wrapAsync&apos;;
import { isAsync } from &apos;./internal/wrapAsync&apos;;
-var FN_ARGS = /^(?:async\s+)?(?:function)?\s*[^(]*\(\s*([^)]+)\s*\)(?:\s*{)/m;
-var ARROW_FN_ARGS = /^(?:async\s+)?(?:function\s+)?\(?\s*([^)^=]+)\s*\)?(?:\s*=&gt;)/m;
+var FN_ARGS = /^(?:async\s+)?(?:function)?\s*\w*\s*\(\s*([^)]+)\s*\)(?:\s*{)/;
+var ARROW_FN_ARGS = /^(?:async\s+)?\(?\s*([^)=]+)\s*\)?(?:\s*=&gt;)/;
var FN_ARG_SPLIT = /,/;
var FN_ARG = /(=.+)?(\s*)$/;
var STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg;
@@ -230,7 +230,7 @@ export default function autoInject(tasks, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/cargo.js.html b/docs/v3/cargo.js.html
index e30d19c..27b2293 100644
--- a/docs/v3/cargo.js.html
+++ b/docs/v3/cargo.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -134,7 +134,7 @@ export default function cargo(worker, payload) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/cargoQueue.js.html b/docs/v3/cargoQueue.js.html
index 388c7e4..5df60aa 100644
--- a/docs/v3/cargoQueue.js.html
+++ b/docs/v3/cargoQueue.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -142,7 +142,7 @@ export default function cargo(worker, concurrency, payload) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/compose.js.html b/docs/v3/compose.js.html
index 953ddbb..f8d27aa 100644
--- a/docs/v3/compose.js.html
+++ b/docs/v3/compose.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -126,7 +126,7 @@ export default function compose(...args) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/concat.js.html b/docs/v3/concat.js.html
index 81c3082..7b9d787 100644
--- a/docs/v3/concat.js.html
+++ b/docs/v3/concat.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -116,7 +116,7 @@ export default awaitify(concat, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/concatLimit.js.html b/docs/v3/concatLimit.js.html
index 9a98c66..57875b3 100644
--- a/docs/v3/concatLimit.js.html
+++ b/docs/v3/concatLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -126,7 +126,7 @@ export default awaitify(concatLimit, 4)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/concatSeries.js.html b/docs/v3/concatSeries.js.html
index 34c8460..7d89348 100644
--- a/docs/v3/concatSeries.js.html
+++ b/docs/v3/concatSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -110,7 +110,7 @@ export default awaitify(concatSeries, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/constant.js.html b/docs/v3/constant.js.html
index 5dada72..a92ba75 100644
--- a/docs/v3/constant.js.html
+++ b/docs/v3/constant.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -131,7 +131,7 @@ export default function(...args) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/detect.js.html b/docs/v3/detect.js.html
index c1edcf1..2833ef3 100644
--- a/docs/v3/detect.js.html
+++ b/docs/v3/detect.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -127,7 +127,7 @@ export default awaitify(detect, 3)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/detectLimit.js.html b/docs/v3/detectLimit.js.html
index 83f3af2..5e70bbc 100644
--- a/docs/v3/detectLimit.js.html
+++ b/docs/v3/detectLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -114,7 +114,7 @@ export default awaitify(detectLimit, 4)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/detectSeries.js.html b/docs/v3/detectSeries.js.html
index 87dc9a5..f4cc348 100644
--- a/docs/v3/detectSeries.js.html
+++ b/docs/v3/detectSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -113,7 +113,7 @@ export default awaitify(detectSeries, 3)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/dir.js.html b/docs/v3/dir.js.html
index a099b25..d10e918 100644
--- a/docs/v3/dir.js.html
+++ b/docs/v3/dir.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -115,7 +115,7 @@ export default consoleFunc(&apos;dir&apos;);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/doUntil.js.html b/docs/v3/doUntil.js.html
index 92345f7..be3c285 100644
--- a/docs/v3/doUntil.js.html
+++ b/docs/v3/doUntil.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -114,7 +114,7 @@ export default function doUntil(iteratee, test, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/doWhilst.js.html b/docs/v3/doWhilst.js.html
index 3d7eff9..a02b91c 100644
--- a/docs/v3/doWhilst.js.html
+++ b/docs/v3/doWhilst.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -134,7 +134,7 @@ export default awaitify(doWhilst, 3)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/docs.html b/docs/v3/docs.html
index 8b11049..efe6f01 100644
--- a/docs/v3/docs.html
+++ b/docs/v3/docs.html
@@ -31,7 +31,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -336,7 +336,9 @@ arrays and objects.</p></div>
<div class="description">
- <pre class="prettyprint source"><code>import concat from &apos;async/concat&apos;;</code></pre><p>Applies <code>iteratee</code> to each item in <code>coll</code>, concatenating the results. Returns
+ <pre class="prettyprint source"><code>import concat from &apos;async/concat&apos;;
+</code></pre>
+<p>Applies <code>iteratee</code> to each item in <code>coll</code>, concatenating the results. Returns
the concatenated list. The <code>iteratee</code>s are called in parallel, and the
results are concatenated as they return. The results array will be returned in
the original order of <code>coll</code> passed to the <code>iteratee</code> function.</p>
@@ -554,7 +556,9 @@ containing the concatenated results of the <code>iteratee</code> function. Invok
<div class="description">
- <pre class="prettyprint source"><code>import concatLimit from &apos;async/concatLimit&apos;;</code></pre><p>The same as <a href="#concat"><code>concat</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import concatLimit from &apos;async/concatLimit&apos;;
+</code></pre>
+<p>The same as <a href="#concat"><code>concat</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -792,7 +796,9 @@ containing the concatenated results of the <code>iteratee</code> function. Invok
<div class="description">
- <pre class="prettyprint source"><code>import concatSeries from &apos;async/concatSeries&apos;;</code></pre><p>The same as <a href="#concat"><code>concat</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import concatSeries from &apos;async/concatSeries&apos;;
+</code></pre>
+<p>The same as <a href="#concat"><code>concat</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -1008,7 +1014,9 @@ containing the concatenated results of the <code>iteratee</code> function. Invok
<div class="description">
- <pre class="prettyprint source"><code>import detect from &apos;async/detect&apos;;</code></pre><p>Returns the first value in <code>coll</code> that passes an async truth test. The
+ <pre class="prettyprint source"><code>import detect from &apos;async/detect&apos;;
+</code></pre>
+<p>Returns the first value in <code>coll</code> that passes an async truth test. The
<code>iteratee</code> is applied in parallel, meaning the first iteratee to return
<code>true</code> will fire the detect <code>callback</code> with that result. That means the
result might not be the first item in the original <code>coll</code> (in terms of order)
@@ -1235,7 +1243,9 @@ Result will be the first item in the array that passes the truth test
<div class="description">
- <pre class="prettyprint source"><code>import detectLimit from &apos;async/detectLimit&apos;;</code></pre><p>The same as <a href="#detect"><code>detect</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import detectLimit from &apos;async/detectLimit&apos;;
+</code></pre>
+<p>The same as <a href="#detect"><code>detect</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -1476,7 +1486,9 @@ Result will be the first item in the array that passes the truth test
<div class="description">
- <pre class="prettyprint source"><code>import detectSeries from &apos;async/detectSeries&apos;;</code></pre><p>The same as <a href="#detect"><code>detect</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import detectSeries from &apos;async/detectSeries&apos;;
+</code></pre>
+<p>The same as <a href="#detect"><code>detect</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -1693,7 +1705,9 @@ Result will be the first item in the array that passes the truth test
<div class="description">
- <pre class="prettyprint source"><code>import each from &apos;async/each&apos;;</code></pre><p>Applies the function <code>iteratee</code> to each item in <code>coll</code>, in parallel.
+ <pre class="prettyprint source"><code>import each from &apos;async/each&apos;;
+</code></pre>
+<p>Applies the function <code>iteratee</code> to each item in <code>coll</code>, in parallel.
The <code>iteratee</code> is called with an item from the list, and a callback for when
it has finished. If the <code>iteratee</code> passes an error to its <code>callback</code>, the
main <code>callback</code> (for the <code>each</code> function) is immediately called with the
@@ -1954,7 +1968,9 @@ async.each(openFiles, function(file, callback) {
<div class="description">
- <pre class="prettyprint source"><code>import eachLimit from &apos;async/eachLimit&apos;;</code></pre><p>The same as <a href="#each"><code>each</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import eachLimit from &apos;async/eachLimit&apos;;
+</code></pre>
+<p>The same as <a href="#each"><code>each</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -2205,7 +2221,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import eachOf from &apos;async/eachOf&apos;;</code></pre><p>Like <a href="#each"><code>each</code></a>, except that it passes the key (or index) as the second argument
+ <pre class="prettyprint source"><code>import eachOf from &apos;async/eachOf&apos;;
+</code></pre>
+<p>Like <a href="#each"><code>each</code></a>, except that it passes the key (or index) as the second argument
to the iteratee.</p>
</div>
@@ -2455,7 +2473,9 @@ async.forEachOf(obj, function (value, key, callback) {
<div class="description">
- <pre class="prettyprint source"><code>import eachOfLimit from &apos;async/eachOfLimit&apos;;</code></pre><p>The same as <a href="#eachOf"><code>eachOf</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import eachOfLimit from &apos;async/eachOfLimit&apos;;
+</code></pre>
+<p>The same as <a href="#eachOf"><code>eachOf</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -2706,7 +2726,9 @@ Invoked with (item, key, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import eachOfSeries from &apos;async/eachOfSeries&apos;;</code></pre><p>The same as <a href="#eachOf"><code>eachOf</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import eachOfSeries from &apos;async/eachOfSeries&apos;;
+</code></pre>
+<p>The same as <a href="#eachOf"><code>eachOf</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -2932,7 +2954,9 @@ functions have finished, or an error occurs. Invoked with (err).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import eachSeries from &apos;async/eachSeries&apos;;</code></pre><p>The same as <a href="#each"><code>each</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import eachSeries from &apos;async/eachSeries&apos;;
+</code></pre>
+<p>The same as <a href="#each"><code>each</code></a> but runs only a single async operation at a time.</p>
<p>Note, that unlike <a href="#each"><code>each</code></a>, this function applies iteratee to each item
in series and therefore the iteratee functions will complete in order.</p>
</div>
@@ -3162,7 +3186,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import every from &apos;async/every&apos;;</code></pre><p>Returns <code>true</code> if every element in <code>coll</code> satisfies an async test. If any
+ <pre class="prettyprint source"><code>import every from &apos;async/every&apos;;
+</code></pre>
+<p>Returns <code>true</code> if every element in <code>coll</code> satisfies an async test. If any
iteratee call returns <code>false</code>, the main <code>callback</code> is immediately called.</p>
</div>
@@ -3395,7 +3421,9 @@ depending on the values of the async tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import everyLimit from &apos;async/everyLimit&apos;;</code></pre><p>The same as <a href="#every"><code>every</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import everyLimit from &apos;async/everyLimit&apos;;
+</code></pre>
+<p>The same as <a href="#every"><code>every</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -3646,7 +3674,9 @@ depending on the values of the async tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import everySeries from &apos;async/everySeries&apos;;</code></pre><p>The same as <a href="#every"><code>every</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import everySeries from &apos;async/everySeries&apos;;
+</code></pre>
+<p>The same as <a href="#every"><code>every</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -3874,7 +3904,9 @@ depending on the values of the async tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import filter from &apos;async/filter&apos;;</code></pre><p>Returns a new array of all the values in <code>coll</code> which pass an async truth
+ <pre class="prettyprint source"><code>import filter from &apos;async/filter&apos;;
+</code></pre>
+<p>Returns a new array of all the values in <code>coll</code> which pass an async truth
test. This operation is performed in parallel, but the results array will be
in the same order as the original.</p>
</div>
@@ -4106,7 +4138,9 @@ with a boolean argument once it has completed. Invoked with (item, callback).</p
<div class="description">
- <pre class="prettyprint source"><code>import filterLimit from &apos;async/filterLimit&apos;;</code></pre><p>The same as <a href="#filter"><code>filter</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import filterLimit from &apos;async/filterLimit&apos;;
+</code></pre>
+<p>The same as <a href="#filter"><code>filter</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -4356,7 +4390,9 @@ with a boolean argument once it has completed. Invoked with (item, callback).</p
<div class="description">
- <pre class="prettyprint source"><code>import filterSeries from &apos;async/filterSeries&apos;;</code></pre><p>The same as <a href="#filter"><code>filter</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import filterSeries from &apos;async/filterSeries&apos;;
+</code></pre>
+<p>The same as <a href="#filter"><code>filter</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -4582,7 +4618,9 @@ with a boolean argument once it has completed. Invoked with (item, callback).</p
<div class="description">
- <pre class="prettyprint source"><code>import groupBy from &apos;async/groupBy&apos;;</code></pre><p>Returns a new object, where each value corresponds to an array of items, from
+ <pre class="prettyprint source"><code>import groupBy from &apos;async/groupBy&apos;;
+</code></pre>
+<p>Returns a new object, where each value corresponds to an array of items, from
<code>coll</code>, that returned the corresponding key. That is, the keys of the object
correspond to the values passed to the <code>iteratee</code> callback.</p>
<p>Note: Since this function applies the <code>iteratee</code> to each item in parallel,
@@ -4818,7 +4856,9 @@ properties are arrays of values which returned the corresponding key.</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import groupByLimit from &apos;async/groupByLimit&apos;;</code></pre><p>The same as <a href="#groupBy"><code>groupBy</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import groupByLimit from &apos;async/groupByLimit&apos;;
+</code></pre>
+<p>The same as <a href="#groupBy"><code>groupBy</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -5064,7 +5104,9 @@ properties are arrays of values which returned the corresponding key.</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import groupBySeries from &apos;async/groupBySeries&apos;;</code></pre><p>The same as <a href="#groupBy"><code>groupBy</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import groupBySeries from &apos;async/groupBySeries&apos;;
+</code></pre>
+<p>The same as <a href="#groupBy"><code>groupBy</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -5287,7 +5329,9 @@ properties are arrays of values which returned the corresponding key.</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import map from &apos;async/map&apos;;</code></pre><p>Produces a new collection of values by mapping each value in <code>coll</code> through
+ <pre class="prettyprint source"><code>import map from &apos;async/map&apos;;
+</code></pre>
+<p>Produces a new collection of values by mapping each value in <code>coll</code> through
the <code>iteratee</code> function. The <code>iteratee</code> is called with an item from <code>coll</code>
and a callback for when it has finished processing. Each of these callback
takes 2 arguments: an <code>error</code>, and the transformed item from <code>coll</code>. If
@@ -5522,7 +5566,9 @@ transformed items from the <code>coll</code>. Invoked with (err, results).</p></
<div class="description">
- <pre class="prettyprint source"><code>import mapLimit from &apos;async/mapLimit&apos;;</code></pre><p>The same as <a href="#map"><code>map</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import mapLimit from &apos;async/mapLimit&apos;;
+</code></pre>
+<p>The same as <a href="#map"><code>map</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -5768,7 +5814,9 @@ transformed items from the <code>coll</code>. Invoked with (err, results).</p></
<div class="description">
- <pre class="prettyprint source"><code>import mapSeries from &apos;async/mapSeries&apos;;</code></pre><p>The same as <a href="#map"><code>map</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import mapSeries from &apos;async/mapSeries&apos;;
+</code></pre>
+<p>The same as <a href="#map"><code>map</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -5991,7 +6039,9 @@ transformed items from the <code>coll</code>. Invoked with (err, results).</p></
<div class="description">
- <pre class="prettyprint source"><code>import mapValues from &apos;async/mapValues&apos;;</code></pre><p>A relative of <a href="#map"><code>map</code></a>, designed for use with objects.</p>
+ <pre class="prettyprint source"><code>import mapValues from &apos;async/mapValues&apos;;
+</code></pre>
+<p>A relative of <a href="#map"><code>map</code></a>, designed for use with objects.</p>
<p>Produces a new Object by mapping each value of <code>obj</code> through the <code>iteratee</code>
function. The <code>iteratee</code> is called each <code>value</code> and <code>key</code> from <code>obj</code> and a
callback for when it has finished processing. Each of these callbacks takes
@@ -6225,7 +6275,9 @@ Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import mapValuesLimit from &apos;async/mapValuesLimit&apos;;</code></pre><p>The same as <a href="#mapValues"><code>mapValues</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import mapValuesLimit from &apos;async/mapValuesLimit&apos;;
+</code></pre>
+<p>The same as <a href="#mapValues"><code>mapValues</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -6464,7 +6516,9 @@ Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import mapValuesSeries from &apos;async/mapValuesSeries&apos;;</code></pre><p>The same as <a href="#mapValues"><code>mapValues</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import mapValuesSeries from &apos;async/mapValuesSeries&apos;;
+</code></pre>
+<p>The same as <a href="#mapValues"><code>mapValues</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -6679,7 +6733,9 @@ Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import reduce from &apos;async/reduce&apos;;</code></pre><p>Reduces <code>coll</code> into a single value using an async <code>iteratee</code> to return each
+ <pre class="prettyprint source"><code>import reduce from &apos;async/reduce&apos;;
+</code></pre>
+<p>Reduces <code>coll</code> into a single value using an async <code>iteratee</code> to return each
successive step. <code>memo</code> is the initial state of the reduction. This function
only operates in series.</p>
<p>For performance reasons, it may make sense to split a call to this function
@@ -6944,7 +7000,9 @@ Invoked with (memo, item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import reduceRight from &apos;async/reduceRight&apos;;</code></pre><p>Same as <a href="#reduce"><code>reduce</code></a>, only operates on <code>array</code> in reverse order.</p>
+ <pre class="prettyprint source"><code>import reduceRight from &apos;async/reduceRight&apos;;
+</code></pre>
+<p>Same as <a href="#reduce"><code>reduce</code></a>, only operates on <code>array</code> in reverse order.</p>
</div>
@@ -7188,7 +7246,9 @@ Invoked with (memo, item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import reject from &apos;async/reject&apos;;</code></pre><p>The opposite of <a href="#filter"><code>filter</code></a>. Removes values that pass an <code>async</code> truth test.</p>
+ <pre class="prettyprint source"><code>import reject from &apos;async/reject&apos;;
+</code></pre>
+<p>The opposite of <a href="#filter"><code>filter</code></a>. Removes values that pass an <code>async</code> truth test.</p>
</div>
@@ -7422,7 +7482,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import rejectLimit from &apos;async/rejectLimit&apos;;</code></pre><p>The same as <a href="#reject"><code>reject</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import rejectLimit from &apos;async/rejectLimit&apos;;
+</code></pre>
+<p>The same as <a href="#reject"><code>reject</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -7668,7 +7730,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import rejectSeries from &apos;async/rejectSeries&apos;;</code></pre><p>The same as <a href="#reject"><code>reject</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import rejectSeries from &apos;async/rejectSeries&apos;;
+</code></pre>
+<p>The same as <a href="#reject"><code>reject</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -7890,7 +7954,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import some from &apos;async/some&apos;;</code></pre><p>Returns <code>true</code> if at least one element in the <code>coll</code> satisfies an async test.
+ <pre class="prettyprint source"><code>import some from &apos;async/some&apos;;
+</code></pre>
+<p>Returns <code>true</code> if at least one element in the <code>coll</code> satisfies an async test.
If any iteratee call returns <code>true</code>, the main <code>callback</code> is immediately
called.</p>
</div>
@@ -8125,7 +8191,9 @@ tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import someLimit from &apos;async/someLimit&apos;;</code></pre><p>The same as <a href="#some"><code>some</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import someLimit from &apos;async/someLimit&apos;;
+</code></pre>
+<p>The same as <a href="#some"><code>some</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -8377,7 +8445,9 @@ tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import someSeries from &apos;async/someSeries&apos;;</code></pre><p>The same as <a href="#some"><code>some</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import someSeries from &apos;async/someSeries&apos;;
+</code></pre>
+<p>The same as <a href="#some"><code>some</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -8606,7 +8676,9 @@ tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import sortBy from &apos;async/sortBy&apos;;</code></pre><p>Sorts a list by the results of running each <code>coll</code> value through an async
+ <pre class="prettyprint source"><code>import sortBy from &apos;async/sortBy&apos;;
+</code></pre>
+<p>Sorts a list by the results of running each <code>coll</code> value through an async
<code>iteratee</code>.</p>
</div>
@@ -8852,7 +8924,9 @@ async.sortBy([1,9,3,5], function(x, callback) {
<div class="description">
- <pre class="prettyprint source"><code>import transform from &apos;async/transform&apos;;</code></pre><p>A relative of <code>reduce</code>. Takes an Object or Array, and iterates over each
+ <pre class="prettyprint source"><code>import transform from &apos;async/transform&apos;;
+</code></pre>
+<p>A relative of <code>reduce</code>. Takes an Object or Array, and iterates over each
element in parallel, each step potentially mutating an <code>accumulator</code> value.
The type of the accumulator defaults to the type of collection passed in.</p>
</div>
@@ -9250,7 +9324,9 @@ Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import applyEach from &apos;async/applyEach&apos;;</code></pre><p>Applies the provided arguments to each function in the array, calling
+ <pre class="prettyprint source"><code>import applyEach from &apos;async/applyEach&apos;;
+</code></pre>
+<p>Applies the provided arguments to each function in the array, calling
<code>callback</code> after all functions have completed. If you only provide the first
argument, <code>fns</code>, then it will return a function which lets you pass in the
arguments as if it were a single function call. If more arguments are
@@ -9493,7 +9569,9 @@ async.each(
<div class="description">
- <pre class="prettyprint source"><code>import applyEachSeries from &apos;async/applyEachSeries&apos;;</code></pre><p>The same as <a href="#applyEach"><code>applyEach</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import applyEachSeries from &apos;async/applyEachSeries&apos;;
+</code></pre>
+<p>The same as <a href="#applyEach"><code>applyEach</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -9720,7 +9798,9 @@ a callback.</li>
<div class="description">
- <pre class="prettyprint source"><code>import auto from &apos;async/auto&apos;;</code></pre><p>Determines the best order for running the <a href="global.html">AsyncFunction</a>s in <code>tasks</code>, based on
+ <pre class="prettyprint source"><code>import auto from &apos;async/auto&apos;;
+</code></pre>
+<p>Determines the best order for running the <a href="global.html">AsyncFunction</a>s in <code>tasks</code>, based on
their requirements. Each function can optionally depend on other functions
being completed first, and each function is run as soon as its requirements
are satisfied.</p>
@@ -10008,7 +10088,9 @@ async.auto({
<div class="description">
- <pre class="prettyprint source"><code>import autoInject from &apos;async/autoInject&apos;;</code></pre><p>A dependency-injected version of the <a href="#auto">async.auto</a> function. Dependent
+ <pre class="prettyprint source"><code>import autoInject from &apos;async/autoInject&apos;;
+</code></pre>
+<p>A dependency-injected version of the <a href="#auto">async.auto</a> function. Dependent
tasks are specified as parameters to the function, after the usual callback
parameter, with the parameter names matching the names of the tasks it
depends on. This can provide even more readable task graphs which can be
@@ -10266,7 +10348,9 @@ async.autoInject({
<div class="description">
- <pre class="prettyprint source"><code>import cargo from &apos;async/cargo&apos;;</code></pre><p>Creates a <code>cargo</code> object with the specified payload. Tasks added to the
+ <pre class="prettyprint source"><code>import cargo from &apos;async/cargo&apos;;
+</code></pre>
+<p>Creates a <code>cargo</code> object with the specified payload. Tasks added to the
cargo will be processed altogether (up to the <code>payload</code> limit). If the
<code>worker</code> is in progress, the task is queued until it becomes available. Once
the <code>worker</code> has completed some tasks, each callback of those tasks is
@@ -10498,7 +10582,9 @@ console.log(&apos;finished processing baz&apos;);</code></pre>
<div class="description">
- <pre class="prettyprint source"><code>import cargoQueue from &apos;async/cargoQueue&apos;;</code></pre><p>Creates a <code>cargoQueue</code> object with the specified payload. Tasks added to the
+ <pre class="prettyprint source"><code>import cargoQueue from &apos;async/cargoQueue&apos;;
+</code></pre>
+<p>Creates a <code>cargoQueue</code> object with the specified payload. Tasks added to the
cargoQueue will be processed together (up to the <code>payload</code> limit) in <code>concurrency</code> parallel workers.
If the all <code>workers</code> are in progress, the task is queued until one becomes available. Once
a <code>worker</code> has completed some tasks, each callback of those tasks is
@@ -10769,7 +10855,9 @@ cargoQueue.push({name: &apos;boo&apos;}, function(err) {
<div class="description">
- <pre class="prettyprint source"><code>import compose from &apos;async/compose&apos;;</code></pre><p>Creates a function which is a composition of the passed asynchronous
+ <pre class="prettyprint source"><code>import compose from &apos;async/compose&apos;;
+</code></pre>
+<p>Creates a function which is a composition of the passed asynchronous
functions. Each function consumes the return value of the function that
follows. Composing functions <code>f()</code>, <code>g()</code>, and <code>h()</code> would produce the result
of <code>f(g(h()))</code>, only this version uses callbacks to obtain the return values.</p>
@@ -10950,7 +11038,9 @@ add1mul3(4, function (err, result) {
<div class="description">
- <pre class="prettyprint source"><code>import doUntil from &apos;async/doUntil&apos;;</code></pre><p>Like <a href="#doWhilst">&apos;doWhilst&apos;</a>, except the <code>test</code> is inverted. Note the
+ <pre class="prettyprint source"><code>import doUntil from &apos;async/doUntil&apos;;
+</code></pre>
+<p>Like <a href="#doWhilst">&apos;doWhilst&apos;</a>, except the <code>test</code> is inverted. Note the
argument ordering differs from <code>until</code>.</p>
</div>
@@ -11166,7 +11256,9 @@ callback. Invoked with (err, [results]);</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import doWhilst from &apos;async/doWhilst&apos;;</code></pre><p>The post-check version of <a href="#whilst"><code>whilst</code></a>. To reflect the difference in
+ <pre class="prettyprint source"><code>import doWhilst from &apos;async/doWhilst&apos;;
+</code></pre>
+<p>The post-check version of <a href="#whilst"><code>whilst</code></a>. To reflect the difference in
the order of operations, the arguments <code>test</code> and <code>iteratee</code> are switched.</p>
<p><code>doWhilst</code> is to <code>whilst</code> as <code>do while</code> is to <code>while</code> in plain JavaScript.</p>
</div>
@@ -11383,7 +11475,9 @@ function has failed and repeated execution of <code>iteratee</code> has stopped.
<div class="description">
- <pre class="prettyprint source"><code>import forever from &apos;async/forever&apos;;</code></pre><p>Calls the asynchronous function <code>fn</code> with a callback parameter that allows it
+ <pre class="prettyprint source"><code>import forever from &apos;async/forever&apos;;
+</code></pre>
+<p>Calls the asynchronous function <code>fn</code> with a callback parameter that allows it
to call itself again, in series, indefinitely.
If an error is passed to the callback then <code>errback</code> is called with the
error, and execution stops, otherwise it will never be called.</p>
@@ -11582,7 +11676,9 @@ is not passed</p>
<div class="description">
- <pre class="prettyprint source"><code>import parallel from &apos;async/parallel&apos;;</code></pre><p>Run the <code>tasks</code> collection of functions in parallel, without waiting until
+ <pre class="prettyprint source"><code>import parallel from &apos;async/parallel&apos;;
+</code></pre>
+<p>Run the <code>tasks</code> collection of functions in parallel, without waiting until
the previous function has completed. If any of the functions pass an error to
its callback, the main <code>callback</code> is immediately called with the value of the
error. Once the <code>tasks</code> have completed, the results are passed to the final
@@ -11827,7 +11923,9 @@ async.parallel({
<div class="description">
- <pre class="prettyprint source"><code>import parallelLimit from &apos;async/parallelLimit&apos;;</code></pre><p>The same as <a href="#parallel"><code>parallel</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import parallelLimit from &apos;async/parallelLimit&apos;;
+</code></pre>
+<p>The same as <a href="#parallel"><code>parallel</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -12051,7 +12149,9 @@ Invoked with (err, results).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import priorityQueue from &apos;async/priorityQueue&apos;;</code></pre><p>The same as <a href="#queue">async.queue</a> only tasks are assigned a priority and
+ <pre class="prettyprint source"><code>import priorityQueue from &apos;async/priorityQueue&apos;;
+</code></pre>
+<p>The same as <a href="#queue">async.queue</a> only tasks are assigned a priority and
completed in ascending priority order.</p>
</div>
@@ -12247,7 +12347,9 @@ array of <code>tasks</code> is given, all tasks will be assigned the same priori
<div class="description">
- <pre class="prettyprint source"><code>import queue from &apos;async/queue&apos;;</code></pre><p>Creates a <code>queue</code> object with the specified <code>concurrency</code>. Tasks added to the
+ <pre class="prettyprint source"><code>import queue from &apos;async/queue&apos;;
+</code></pre>
+<p>Creates a <code>queue</code> object with the specified <code>concurrency</code>. Tasks added to the
<code>queue</code> are processed in parallel (up to the <code>concurrency</code> limit). If all
<code>worker</code>s are in progress, the task is queued until one becomes available.
Once a <code>worker</code> completes a <code>task</code>, that <code>task</code>&apos;s callback is called.</p>
@@ -12451,7 +12553,7 @@ q.unshift({name: &apos;bar&apos;}, function (err) {
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="queue.js.html">queue.js</a>, <a href="queue.js.html#line85">line 85</a>
+ <a href="queue.js.html">queue.js</a>, <a href="queue.js.html#line89">line 89</a>
</li></ul></dd>
@@ -12485,7 +12587,9 @@ q.unshift({name: &apos;bar&apos;}, function (err) {
<div class="description">
- <pre class="prettyprint source"><code>import race from &apos;async/race&apos;;</code></pre><p>Runs the <code>tasks</code> array of functions in parallel, without waiting until the
+ <pre class="prettyprint source"><code>import race from &apos;async/race&apos;;
+</code></pre>
+<p>Runs the <code>tasks</code> array of functions in parallel, without waiting until the
previous function has completed. Once any of the <code>tasks</code> complete or pass an
error to its callback, the main <code>callback</code> is immediately called. It&apos;s
equivalent to <code>Promise.race()</code>.</p>
@@ -12676,7 +12780,9 @@ function(err, result) {
<div class="description">
- <pre class="prettyprint source"><code>import retry from &apos;async/retry&apos;;</code></pre><p>Attempts to get a successful response from <code>task</code> no more than <code>times</code> times
+ <pre class="prettyprint source"><code>import retry from &apos;async/retry&apos;;
+</code></pre>
+<p>Attempts to get a successful response from <code>task</code> no more than <code>times</code> times
before returning an error. If the task is successful, the <code>callback</code> will be
passed the result of the successful task. If all attempts fail, the callback
will be passed the error and result (if any) of the final attempt.</p>
@@ -12979,7 +13085,9 @@ async.auto({
<div class="description">
- <pre class="prettyprint source"><code>import retryable from &apos;async/retryable&apos;;</code></pre><p>A close relative of <a href="#retry"><code>retry</code></a>. This method
+ <pre class="prettyprint source"><code>import retryable from &apos;async/retryable&apos;;
+</code></pre>
+<p>A close relative of <a href="#retry"><code>retry</code></a>. This method
wraps a task and makes it retryable, rather than immediately calling it
with retries.</p>
</div>
@@ -13198,7 +13306,9 @@ This function will accept the same parameters as <code>task</code>.</p>
<div class="description">
- <pre class="prettyprint source"><code>import seq from &apos;async/seq&apos;;</code></pre><p>Version of the compose function that is more natural to read. Each function
+ <pre class="prettyprint source"><code>import seq from &apos;async/seq&apos;;
+</code></pre>
+<p>Version of the compose function that is more natural to read. Each function
consumes the return value of the previous function. It is the equivalent of
<a href="#compose">compose</a> with the arguments reversed.</p>
<p>Each function is executed with the <code>this</code> binding of the composed function.</p>
@@ -13386,7 +13496,9 @@ app.get(&apos;/cats&apos;, function(request, response) {
<div class="description">
- <pre class="prettyprint source"><code>import series from &apos;async/series&apos;;</code></pre><p>Run the functions in the <code>tasks</code> collection in series, each one running once
+ <pre class="prettyprint source"><code>import series from &apos;async/series&apos;;
+</code></pre>
+<p>Run the functions in the <code>tasks</code> collection in series, each one running once
the previous function has completed. If any functions in the series pass an
error to its callback, no more functions are run, and <code>callback</code> is
immediately called with the value of the error. Otherwise, <code>callback</code>
@@ -13394,7 +13506,7 @@ receives an array of results when <code>tasks</code> have completed.</p>
<p>It is also possible to use an object instead of an array. Each property will
be run as a function, and the results will be passed to the final <code>callback</code>
as an object instead of an array. This can be a more readable way of handling
- results from async.series.</p>
+results from async.series.</p>
<p><strong>Note</strong> that while many implementations preserve the order of object
properties, the <a href="http://www.ecma-international.org/ecma-262/5.1/#sec-8.6">ECMAScript Language Specification</a>
explicitly states that</p>
@@ -13628,7 +13740,9 @@ async.series({
<div class="description">
- <pre class="prettyprint source"><code>import times from &apos;async/times&apos;;</code></pre><p>Calls the <code>iteratee</code> function <code>n</code> times, and accumulates results in the same
+ <pre class="prettyprint source"><code>import times from &apos;async/times&apos;;
+</code></pre>
+<p>Calls the <code>iteratee</code> function <code>n</code> times, and accumulates results in the same
manner you would use with <a href="#map">map</a>.</p>
</div>
@@ -13856,7 +13970,9 @@ async.times(5, function(n, next) {
<div class="description">
- <pre class="prettyprint source"><code>import timesLimit from &apos;async/timesLimit&apos;;</code></pre><p>The same as <a href="#times">times</a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import timesLimit from &apos;async/timesLimit&apos;;
+</code></pre>
+<p>The same as <a href="#times">times</a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -14088,7 +14204,9 @@ Invoked with the iteration index and a callback: (n, next).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import timesSeries from &apos;async/timesSeries&apos;;</code></pre><p>The same as <a href="#times">times</a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import timesSeries from &apos;async/timesSeries&apos;;
+</code></pre>
+<p>The same as <a href="#times">times</a> but runs only a single async operation at a time.</p>
</div>
@@ -14296,7 +14414,9 @@ Invoked with the iteration index and a callback: (n, next).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import tryEach from &apos;async/tryEach&apos;;</code></pre><p>It runs each task in series but stops whenever any of the functions were
+ <pre class="prettyprint source"><code>import tryEach from &apos;async/tryEach&apos;;
+</code></pre>
+<p>It runs each task in series but stops whenever any of the functions were
successful. If one of the tasks were successful, the <code>callback</code> will be
passed the result of the successful task. If all tasks fail, the callback
will be passed the error and result (if any) of the final attempt.</p>
@@ -14512,7 +14632,9 @@ function(err, results) {
<div class="description">
- <pre class="prettyprint source"><code>import until from &apos;async/until&apos;;</code></pre><p>Repeatedly call <code>iteratee</code> until <code>test</code> returns <code>true</code>. Calls <code>callback</code> when
+ <pre class="prettyprint source"><code>import until from &apos;async/until&apos;;
+</code></pre>
+<p>Repeatedly call <code>iteratee</code> until <code>test</code> returns <code>true</code>. Calls <code>callback</code> when
stopped, or an error occurs. <code>callback</code> will be passed an error and any
arguments passed to the final <code>iteratee</code>&apos;s callback.</p>
<p>The inverse of <a href="#whilst">whilst</a>.</p>
@@ -14745,7 +14867,9 @@ async.until(function test(page, cb) {
<div class="description">
- <pre class="prettyprint source"><code>import waterfall from &apos;async/waterfall&apos;;</code></pre><p>Runs the <code>tasks</code> array of functions in series, each passing their results to
+ <pre class="prettyprint source"><code>import waterfall from &apos;async/waterfall&apos;;
+</code></pre>
+<p>Runs the <code>tasks</code> array of functions in series, each passing their results to
the next in the array. However, if any of the <code>tasks</code> pass an error to their
own callback, the next function is not executed, and the main <code>callback</code> is
immediately called with the error.</p>
@@ -14959,7 +15083,9 @@ function myLastFunction(arg1, callback) {
<div class="description">
- <pre class="prettyprint source"><code>import whilst from &apos;async/whilst&apos;;</code></pre><p>Repeatedly call <code>iteratee</code>, while <code>test</code> returns <code>true</code>. Calls <code>callback</code> when
+ <pre class="prettyprint source"><code>import whilst from &apos;async/whilst&apos;;
+</code></pre>
+<p>Repeatedly call <code>iteratee</code>, while <code>test</code> returns <code>true</code>. Calls <code>callback</code> when
stopped, or an error occurs.</p>
</div>
@@ -15186,7 +15312,9 @@ async.whilst(
<div class="description">
- <pre class="prettyprint source"><code>import queue from &apos;async/queue&apos;;</code></pre><p>A queue of tasks for the worker function to complete.</p>
+ <pre class="prettyprint source"><code>import queue from &apos;async/queue&apos;;
+</code></pre>
+<p>A queue of tasks for the worker function to complete.</p>
</div>
@@ -15407,7 +15535,7 @@ passed to the worker function at a time. only applies if this is a
<td class="type">
-<span class="param-type">function</span>
+<span class="param-type"><a href="global.html">AsyncFunction</a></span>
@@ -15433,7 +15561,7 @@ task in the list. Invoke with <code>queue.push(task, [callback])</code>,</p></td
<td class="type">
-<span class="param-type">function</span>
+<span class="param-type"><a href="global.html">AsyncFunction</a></span>
@@ -15451,6 +15579,54 @@ Invoke with <code>queue.unshift(task, [callback])</code>.</p></td>
<tr>
+ <td class="name"><code>pushAsync</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="global.html">AsyncFunction</a></span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the same as <code>q.push</code>, except this returns
+a promise that rejects if an error occurs.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>unshirtAsync</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="global.html">AsyncFunction</a></span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the same as <code>q.unshift</code>, except this returns
+a promise that rejects if an error occurs.</p></td>
+ </tr>
+
+
+
+ <tr>
+
<td class="name"><code>remove</code></td>
@@ -15939,7 +16115,9 @@ await q.drain()</code></pre>
<div class="description">
- <pre class="prettyprint source"><code>import apply from &apos;async/apply&apos;;</code></pre><p>Creates a continuation function with some arguments already applied.</p>
+ <pre class="prettyprint source"><code>import apply from &apos;async/apply&apos;;
+</code></pre>
+<p>Creates a continuation function with some arguments already applied.</p>
<p>Useful as a shorthand when combined with other control flow functions. Any
arguments passed to the returned function are added to the arguments
originally passed to apply.</p>
@@ -16150,7 +16328,9 @@ three</code></pre>
<div class="description">
- <pre class="prettyprint source"><code>import asyncify from &apos;async/asyncify&apos;;</code></pre><p>Take a sync function and make it async, passing its return value to a
+ <pre class="prettyprint source"><code>import asyncify from &apos;async/asyncify&apos;;
+</code></pre>
+<p>Take a sync function and make it async, passing its return value to a
callback. This is useful for plugging sync functions into a waterfall,
series, or other async functions. Any arguments passed to the generated
function will be passed to the wrapped function (except for the final
@@ -16353,7 +16533,9 @@ q.push(files);</code></pre>
<div class="description">
- <pre class="prettyprint source"><code>import constant from &apos;async/constant&apos;;</code></pre><p>Returns a function that when called, calls-back with the values provided.
+ <pre class="prettyprint source"><code>import constant from &apos;async/constant&apos;;
+</code></pre>
+<p>Returns a function that when called, calls-back with the values provided.
Useful as the first function in a <a href="#waterfall"><code>waterfall</code></a>, or for plugging values in to
<a href="#auto"><code>auto</code></a>.</p>
</div>
@@ -16540,7 +16722,9 @@ async.auto({
<div class="description">
- <pre class="prettyprint source"><code>import dir from &apos;async/dir&apos;;</code></pre><p>Logs the result of an <a href="global.html"><code>async</code> function</a> to the
+ <pre class="prettyprint source"><code>import dir from &apos;async/dir&apos;;
+</code></pre>
+<p>Logs the result of an <a href="global.html"><code>async</code> function</a> to the
<code>console</code> using <code>console.dir</code> to display the properties of the resulting object.
Only works in Node.js or in browsers that support <code>console.dir</code> and
<code>console.error</code> (such as FF and Chrome).
@@ -16715,7 +16899,9 @@ node&gt; async.dir(hello, &apos;world&apos;);
<div class="description">
- <pre class="prettyprint source"><code>import ensureAsync from &apos;async/ensureAsync&apos;;</code></pre><p>Wrap an async function and ensure it calls its callback on a later tick of
+ <pre class="prettyprint source"><code>import ensureAsync from &apos;async/ensureAsync&apos;;
+</code></pre>
+<p>Wrap an async function and ensure it calls its callback on a later tick of
the event loop. If the function already calls its callback on a next tick,
no extra deferral is added. This is useful for preventing stack overflows
(<code>RangeError: Maximum call stack size exceeded</code>) and generally keeping
@@ -16895,7 +17081,9 @@ async.mapSeries(args, async.ensureAsync(sometimesAsync), done);</code></pre>
<div class="description">
- <pre class="prettyprint source"><code>import log from &apos;async/log&apos;;</code></pre><p>Logs the result of an <code>async</code> function to the <code>console</code>. Only works in
+ <pre class="prettyprint source"><code>import log from &apos;async/log&apos;;
+</code></pre>
+<p>Logs the result of an <code>async</code> function to the <code>console</code>. Only works in
Node.js or in browsers that support <code>console.log</code> and <code>console.error</code> (such
as FF and Chrome). If multiple arguments are returned from the async
function, <code>console.log</code> is called on each argument in order.</p>
@@ -17068,7 +17256,9 @@ node&gt; async.log(hello, &apos;world&apos;);
<div class="description">
- <pre class="prettyprint source"><code>import memoize from &apos;async/memoize&apos;;</code></pre><p>Caches the results of an async function. When creating a hash to store
+ <pre class="prettyprint source"><code>import memoize from &apos;async/memoize&apos;;
+</code></pre>
+<p>Caches the results of an async function. When creating a hash to store
function results against, the callback is omitted from the hash and an
optional hash function can be used.</p>
<p><strong>Note: if the async function errs, the result will not be cached and
@@ -17272,7 +17462,9 @@ fn(&apos;some name&apos;, function() {
<div class="description">
- <pre class="prettyprint source"><code>import nextTick from &apos;async/nextTick&apos;;</code></pre><p>Calls <code>callback</code> on a later loop around the event loop. In Node.js this just
+ <pre class="prettyprint source"><code>import nextTick from &apos;async/nextTick&apos;;
+</code></pre>
+<p>Calls <code>callback</code> on a later loop around the event loop. In Node.js this just
calls <code>process.nextTick</code>. In the browser it will use <code>setImmediate</code> if
available, otherwise <code>setTimeout(callback, 0)</code>, which means other higher
priority events may precede the execution of <code>callback</code>.</p>
@@ -17454,7 +17646,9 @@ async.setImmediate(function (a, b, c) {
<div class="description">
- <pre class="prettyprint source"><code>import reflect from &apos;async/reflect&apos;;</code></pre><p>Wraps the async function in another function that always completes with a
+ <pre class="prettyprint source"><code>import reflect from &apos;async/reflect&apos;;
+</code></pre>
+<p>Wraps the async function in another function that always completes with a
result object, even when it errors.</p>
<p>The result object has either the property <code>error</code> or <code>value</code>.</p>
</div>
@@ -17639,7 +17833,9 @@ function(err, results) {
<div class="description">
- <pre class="prettyprint source"><code>import reflectAll from &apos;async/reflectAll&apos;;</code></pre><p>A helper function that wraps an array or an object of functions with <code>reflect</code>.</p>
+ <pre class="prettyprint source"><code>import reflectAll from &apos;async/reflectAll&apos;;
+</code></pre>
+<p>A helper function that wraps an array or an object of functions with <code>reflect</code>.</p>
</div>
@@ -17863,7 +18059,9 @@ function(err, results) {
<div class="description">
- <pre class="prettyprint source"><code>import setImmediate from &apos;async/setImmediate&apos;;</code></pre><p>Calls <code>callback</code> on a later loop around the event loop. In Node.js this just
+ <pre class="prettyprint source"><code>import setImmediate from &apos;async/setImmediate&apos;;
+</code></pre>
+<p>Calls <code>callback</code> on a later loop around the event loop. In Node.js this just
calls <code>setImmediate</code>. In the browser it will use <code>setImmediate</code> if
available, otherwise <code>setTimeout(callback, 0)</code>, which means other higher
priority events may precede the execution of <code>callback</code>.</p>
@@ -18045,7 +18243,9 @@ async.setImmediate(function (a, b, c) {
<div class="description">
- <pre class="prettyprint source"><code>import timeout from &apos;async/timeout&apos;;</code></pre><p>Sets a time limit on an asynchronous function. If the function does not call
+ <pre class="prettyprint source"><code>import timeout from &apos;async/timeout&apos;;
+</code></pre>
+<p>Sets a time limit on an asynchronous function. If the function does not call
its callback within the specified milliseconds, it will be called with a
timeout error. The code property for the error object will be <code>&apos;ETIMEDOUT&apos;</code>.</p>
</div>
@@ -18277,7 +18477,9 @@ wrapped({ bar: &apos;bar&apos; }, function(err, data) {
<div class="description">
- <pre class="prettyprint source"><code>import unmemoize from &apos;async/unmemoize&apos;;</code></pre><p>Undoes a <a href="#memoize">memoize</a>d function, reverting it to the original,
+ <pre class="prettyprint source"><code>import unmemoize from &apos;async/unmemoize&apos;;
+</code></pre>
+<p>Undoes a <a href="#memoize">memoize</a>d function, reverting it to the original,
unmemoized form. Handy for testing.</p>
</div>
@@ -18441,7 +18643,7 @@ unmemoized form. Handy for testing.</p>
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/each.js.html b/docs/v3/each.js.html
index 52f89e5..42c70cf 100644
--- a/docs/v3/each.js.html
+++ b/docs/v3/each.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -151,7 +151,7 @@ export default awaitify(eachLimit, 3)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/eachLimit.js.html b/docs/v3/eachLimit.js.html
index 39c26c5..6947946 100644
--- a/docs/v3/eachLimit.js.html
+++ b/docs/v3/eachLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -113,7 +113,7 @@ export default awaitify(eachLimit, 4)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/eachOf.js.html b/docs/v3/eachOf.js.html
index aa4396a..a86132f 100644
--- a/docs/v3/eachOf.js.html
+++ b/docs/v3/eachOf.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -170,7 +170,7 @@ export default awaitify(eachOf, 3)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/eachOfLimit.js.html b/docs/v3/eachOfLimit.js.html
index 8aa9d9b..3ec5ad6 100644
--- a/docs/v3/eachOfLimit.js.html
+++ b/docs/v3/eachOfLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -113,7 +113,7 @@ export default awaitify(eachOfLimit, 4)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/eachOfSeries.js.html b/docs/v3/eachOfSeries.js.html
index 1a434b5..a8c0f69 100644
--- a/docs/v3/eachOfSeries.js.html
+++ b/docs/v3/eachOfSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -108,7 +108,7 @@ export default awaitify(eachOfSeries, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/eachSeries.js.html b/docs/v3/eachSeries.js.html
index b6043c7..63c8c51 100644
--- a/docs/v3/eachSeries.js.html
+++ b/docs/v3/eachSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -113,7 +113,7 @@ export default awaitify(eachSeries, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/ensureAsync.js.html b/docs/v3/ensureAsync.js.html
index 07d2b66..11bd61a 100644
--- a/docs/v3/ensureAsync.js.html
+++ b/docs/v3/ensureAsync.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -137,7 +137,7 @@ export default function ensureAsync(fn) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/every.js.html b/docs/v3/every.js.html
index 1bbabdb..5277ead 100644
--- a/docs/v3/every.js.html
+++ b/docs/v3/every.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -120,7 +120,7 @@ export default awaitify(every, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/everyLimit.js.html b/docs/v3/everyLimit.js.html
index ba86fb2..2399e95 100644
--- a/docs/v3/everyLimit.js.html
+++ b/docs/v3/everyLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -112,7 +112,7 @@ export default awaitify(everyLimit, 4);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/everySeries.js.html b/docs/v3/everySeries.js.html
index 0f34f41..6ca3998 100644
--- a/docs/v3/everySeries.js.html
+++ b/docs/v3/everySeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -111,7 +111,7 @@ export default awaitify(everySeries, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/filter.js.html b/docs/v3/filter.js.html
index 6c8477f..23890ba 100644
--- a/docs/v3/filter.js.html
+++ b/docs/v3/filter.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -119,7 +119,7 @@ export default awaitify(filter, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/filterLimit.js.html b/docs/v3/filterLimit.js.html
index 2332771..1ad6aad 100644
--- a/docs/v3/filterLimit.js.html
+++ b/docs/v3/filterLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -111,7 +111,7 @@ export default awaitify(filterLimit, 4);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/filterSeries.js.html b/docs/v3/filterSeries.js.html
index 45ab095..71550cb 100644
--- a/docs/v3/filterSeries.js.html
+++ b/docs/v3/filterSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -109,7 +109,7 @@ export default awaitify(filterSeries, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/fonts/OpenSans-Semibold-webfont.eot b/docs/v3/fonts/OpenSans-Semibold-webfont.eot
index d8375dd..d8375dd 100644..100755
--- a/docs/v3/fonts/OpenSans-Semibold-webfont.eot
+++ b/docs/v3/fonts/OpenSans-Semibold-webfont.eot
Binary files differ
diff --git a/docs/v3/fonts/OpenSans-Semibold-webfont.svg b/docs/v3/fonts/OpenSans-Semibold-webfont.svg
index eec4db8..eec4db8 100644..100755
--- a/docs/v3/fonts/OpenSans-Semibold-webfont.svg
+++ b/docs/v3/fonts/OpenSans-Semibold-webfont.svg
diff --git a/docs/v3/fonts/OpenSans-Semibold-webfont.ttf b/docs/v3/fonts/OpenSans-Semibold-webfont.ttf
index b329084..b329084 100644..100755
--- a/docs/v3/fonts/OpenSans-Semibold-webfont.ttf
+++ b/docs/v3/fonts/OpenSans-Semibold-webfont.ttf
Binary files differ
diff --git a/docs/v3/fonts/OpenSans-Semibold-webfont.woff b/docs/v3/fonts/OpenSans-Semibold-webfont.woff
index 28d6ade..28d6ade 100644..100755
--- a/docs/v3/fonts/OpenSans-Semibold-webfont.woff
+++ b/docs/v3/fonts/OpenSans-Semibold-webfont.woff
Binary files differ
diff --git a/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.eot b/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.eot
index 0ab1db2..0ab1db2 100644..100755
--- a/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.eot
+++ b/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.eot
Binary files differ
diff --git a/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.svg b/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.svg
index 7166ec1..7166ec1 100644..100755
--- a/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.svg
+++ b/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.svg
diff --git a/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.ttf b/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.ttf
index d2d6318..d2d6318 100644..100755
--- a/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.ttf
+++ b/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.ttf
Binary files differ
diff --git a/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.woff b/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.woff
index d4dfca4..d4dfca4 100644..100755
--- a/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.woff
+++ b/docs/v3/fonts/OpenSans-SemiboldItalic-webfont.woff
Binary files differ
diff --git a/docs/v3/forever.js.html b/docs/v3/forever.js.html
index cf4a409..9f53f1a 100644
--- a/docs/v3/forever.js.html
+++ b/docs/v3/forever.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -131,7 +131,7 @@ export default awaitify(forever, 2)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/global.html b/docs/v3/global.html
index 9d62bcc..9f64e23 100644
--- a/docs/v3/global.html
+++ b/docs/v3/global.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -274,7 +274,7 @@ returns a promise.</p>
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/groupBy.js.html b/docs/v3/groupBy.js.html
index a40f126..0377242 100644
--- a/docs/v3/groupBy.js.html
+++ b/docs/v3/groupBy.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -125,7 +125,7 @@ export default function groupBy (coll, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/groupByLimit.js.html b/docs/v3/groupByLimit.js.html
index d9222c0..5a4efb4 100644
--- a/docs/v3/groupByLimit.js.html
+++ b/docs/v3/groupByLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -137,7 +137,7 @@ export default awaitify(groupByLimit, 4);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/groupBySeries.js.html b/docs/v3/groupBySeries.js.html
index 0592e20..e506221 100644
--- a/docs/v3/groupBySeries.js.html
+++ b/docs/v3/groupBySeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -107,7 +107,7 @@ export default function groupBySeries (coll, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/index.html b/docs/v3/index.html
index b37cb89..ec4341e 100644
--- a/docs/v3/index.html
+++ b/docs/v3/index.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -92,19 +92,20 @@
<p><em>For Async v1.5.x documentation, go <a href="https://github.com/caolan/async/blob/v1.5.2/README.md">HERE</a></em></p>
<p>Async is a utility module which provides straight-forward, powerful functions
for working with asynchronous JavaScript. Although originally designed for
-use with <a href="https://nodejs.org/">Node.js</a> and installable via <code>npm install async</code>,
+use with <a href="https://nodejs.org/">Node.js</a> and installable via <code>npm i async</code>,
it can also be used directly in the browser.</p>
<p>Async is also installable via:</p>
<ul>
<li><a href="https://yarnpkg.com/en/">yarn</a>: <code>yarn add async</code></li>
-<li><a href="http://bower.io/">bower</a>: <code>bower install async</code></li>
</ul>
<p>Async provides around 70 functions that include the usual &apos;functional&apos;
suspects (<code>map</code>, <code>reduce</code>, <code>filter</code>, <code>each</code>&#x2026;) as well as some common patterns
for asynchronous control flow (<code>parallel</code>, <code>series</code>, <code>waterfall</code>&#x2026;). All these
functions assume you follow the Node.js convention of providing a single
callback as the last argument of your asynchronous function -- a callback which expects an Error as its first argument -- and calling the callback once.</p>
-<h2>Quick Examples</h2><pre class="prettyprint source lang-js"><code>async.map([&apos;file1&apos;,&apos;file2&apos;,&apos;file3&apos;], fs.stat, function(err, results) {
+<p>You can also pass <code>async</code> functions to Async methods, instead of callback-accepting functions. For more information, see <a href="global.html#AsyncFunction">AsyncFunction</a></p>
+<h2>Quick Examples</h2>
+<pre class="prettyprint source lang-js"><code>async.map([&apos;file1&apos;,&apos;file2&apos;,&apos;file3&apos;], fs.stat, function(err, results) {
// results is now an array of stats for each file
});
@@ -126,10 +127,14 @@ async.parallel([
async.series([
function(callback) { ... },
function(callback) { ... }
-]);</code></pre><p>There are many more functions available so take a look at the docs below for a
+]);
+</code></pre>
+<p>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.</p>
-<h2>Common Pitfalls <a href="http://stackoverflow.com/questions/tagged/async.js">(StackOverflow)</a></h2><h3>Synchronous iteration functions</h3><p>If you get an error like <code>RangeError: Maximum call stack size exceeded.</code> or other stack overflow issues when using async, you are likely using a synchronous iteratee. By <em>synchronous</em> we mean a function that calls its callback on the same tick in the javascript event loop, without doing any I/O or using any timers. Calling many callbacks iteratively will quickly overflow the stack. If you run into this issue, just defer your callback with <code>async.setImmediate</code> to start a new call stack on the next tick of the event loop.</p>
+<h2>Common Pitfalls <a href="http://stackoverflow.com/questions/tagged/async.js">(StackOverflow)</a></h2>
+<h3>Synchronous iteration functions</h3>
+<p>If you get an error like <code>RangeError: Maximum call stack size exceeded.</code> or other stack overflow issues when using async, you are likely using a synchronous iteratee. By <em>synchronous</em> we mean a function that calls its callback on the same tick in the javascript event loop, without doing any I/O or using any timers. Calling many callbacks iteratively will quickly overflow the stack. If you run into this issue, just defer your callback with <code>async.setImmediate</code> to start a new call stack on the next tick of the event loop.</p>
<p>This can also arise by accident if you callback early in certain cases:</p>
<pre class="prettyprint source lang-js"><code>async.eachSeries(hugeArray, function iteratee(item, callback) {
if (inCache(item)) {
@@ -139,7 +144,9 @@ missing please create a GitHub issue for it.</p>
}
}, function done() {
//...
-});</code></pre><p>Just change it to:</p>
+});
+</code></pre>
+<p>Just change it to:</p>
<pre class="prettyprint source lang-js"><code>async.eachSeries(hugeArray, function iteratee(item, callback) {
if (inCache(item)) {
async.setImmediate(function() {
@@ -149,9 +156,12 @@ missing please create a GitHub issue for it.</p>
doSomeIO(item, callback);
//...
}
-});</code></pre><p>Async does not guard against synchronous iteratees for performance reasons. If you are still running into stack overflows, you can defer as suggested above, or wrap functions with <a href="#ensureAsync"><code>async.ensureAsync</code></a> Functions that are asynchronous by their nature do not have this problem and don&apos;t need the extra callback deferral.</p>
+});
+</code></pre>
+<p>Async does not guard against synchronous iteratees for performance reasons. If you are still running into stack overflows, you can defer as suggested above, or wrap functions with <a href="#ensureAsync"><code>async.ensureAsync</code></a> Functions that are asynchronous by their nature do not have this problem and don&apos;t need the extra callback deferral.</p>
<p>If JavaScript&apos;s event loop is still a bit nebulous, check out <a href="http://blog.carbonfive.com/2013/10/27/the-javascript-event-loop-explained/">this article</a> or <a href="http://2014.jsconf.eu/speakers/philip-roberts-what-the-heck-is-the-event-loop-anyway.html">this talk</a> for more detailed information about how it works.</p>
-<h3>Multiple callbacks</h3><p>Make sure to always <code>return</code> when calling a callback early, otherwise you will cause multiple callbacks and unpredictable behavior in many cases.</p>
+<h3>Multiple callbacks</h3>
+<p>Make sure to always <code>return</code> when calling a callback early, otherwise you will cause multiple callbacks and unpredictable behavior in many cases.</p>
<pre class="prettyprint source lang-js"><code>async.waterfall([
function(callback) {
getSomething(options, function (err, result) {
@@ -165,8 +175,11 @@ missing please create a GitHub issue for it.</p>
});
},
processData
-], done)</code></pre><p>It is always good practice to <code>return callback(err, result)</code> whenever a callback call is not the last statement of a function.</p>
-<h3>Using ES2017 <code>async</code> functions</h3><p>Async accepts <code>async</code> functions wherever we accept a Node-style callback function. However, we do not pass them a callback, and instead use the return value and handle any promise rejections or errors thrown.</p>
+], done)
+</code></pre>
+<p>It is always good practice to <code>return callback(err, result)</code> whenever a callback call is not the last statement of a function.</p>
+<h3>Using ES2017 <code>async</code> functions</h3>
+<p>Async accepts <code>async</code> functions wherever we accept a Node-style callback function. However, we do not pass them a callback, and instead use the return value and handle any promise rejections or errors thrown.</p>
<pre class="prettyprint source lang-js"><code>async.mapLimit(files, 10, async file =&gt; { // &lt;- no callback!
const text = await util.promisify(fs.readFile)(dir + file, &apos;utf8&apos;)
const body = JSON.parse(text) // &lt;- a parse error here will be caught automatically
@@ -177,8 +190,11 @@ missing please create a GitHub issue for it.</p>
}, (err, contents) =&gt; {
if (err) throw err
console.log(contents)
-})</code></pre><p>We can only detect native <code>async</code> functions, not transpiled versions (e.g. with Babel). Otherwise, you can wrap <code>async</code> functions in <code>async.asyncify()</code>.</p>
-<h3>Binding a context to an iteratee</h3><p>This section is really about <code>bind</code>, not about Async. If you are wondering how to
+})
+</code></pre>
+<p>We can only detect native <code>async</code> functions, not transpiled versions (e.g. with Babel). Otherwise, you can wrap <code>async</code> functions in <code>async.asyncify()</code>.</p>
+<h3>Binding a context to an iteratee</h3>
+<p>This section is really about <code>bind</code>, not about Async. If you are wondering how to
make Async execute your iteratees in a given context, or are confused as to why
a method of another library isn&apos;t working as an iteratee, study this example:</p>
<pre class="prettyprint source lang-js"><code>// Here is a simple object with an (unnecessarily roundabout) squaring method
@@ -205,7 +221,10 @@ async.map([1, 2, 3], AsyncSquaringLibrary.square.bind(AsyncSquaringLibrary), fun
// passing it to Async. Now the square function will be executed in its
// &apos;home&apos; AsyncSquaringLibrary context and the value of `this.squareExponent`
// will be as expected.
-});</code></pre><h3>Subtle Memory Leaks</h3><p>There are cases where you might want to exit early from async flow, when calling an Async method inside another async function:</p>
+});
+</code></pre>
+<h3>Subtle Memory Leaks</h3>
+<p>There are cases where you might want to exit early from async flow, when calling an Async method inside another async function:</p>
<pre class="prettyprint source lang-javascript"><code>function myFunction (args, outerCallback) {
async.waterfall([
//...
@@ -218,23 +237,35 @@ async.map([1, 2, 3], AsyncSquaringLibrary.square.bind(AsyncSquaringLibrary), fun
], function done (err) {
//...
})
-}</code></pre><p>Something happened in a waterfall where you want to skip the rest of the execution, so you call an outer callack. However, Async will still wait for that inner <code>next</code> callback to be called, leaving some closure scope allocated.</p>
+}
+</code></pre>
+<p>Something happened in a waterfall where you want to skip the rest of the execution, so you call an outer callack. However, Async will still wait for that inner <code>next</code> callback to be called, leaving some closure scope allocated.</p>
<p>As of version 3.0, you can call any Async callback with <code>false</code> as the <code>error</code> argument, and the rest of the execution of the Async method will be stopped or ignored.</p>
<pre class="prettyprint source lang-javascript"><code> function (arg, next) {
if (someImportantCondition()) {
outerCallback(null)
return next(false) // &#x2190; signal that you called an outer callback
}
- },</code></pre><h3>Mutating collections</h3><p>If you pass an array to a collection method (such as <code>each</code>, <code>mapLimit</code>, or <code>filterSeries</code>), and then attempt to <code>push</code>, <code>pop</code>, or <code>splice</code> additional items on to the array, this could lead to unexpected or undefined behavior. Async will iterate until the original <code>length</code> of the array is met, and the indexes of items <code>pop()</code>ed or <code>splice()</code>d could already have been processed. Therefore, it is not recommended to modify the array after Async has begun iterating over it. If you do need to <code>push</code>, <code>pop</code>, or <code>splice</code>, use a <code>queue</code> instead.</p>
-<h2>Download</h2><p>The source is available for download from
+ },
+</code></pre>
+<h3>Mutating collections while processing them</h3>
+<p>If you pass an array to a collection method (such as <code>each</code>, <code>mapLimit</code>, or <code>filterSeries</code>), and then attempt to <code>push</code>, <code>pop</code>, or <code>splice</code> additional items on to the array, this could lead to unexpected or undefined behavior. Async will iterate until the original <code>length</code> of the array is met, and the indexes of items <code>pop()</code>ed or <code>splice()</code>d could already have been processed. Therefore, it is not recommended to modify the array after Async has begun iterating over it. If you do need to <code>push</code>, <code>pop</code>, or <code>splice</code>, use a <code>queue</code> instead.</p>
+<h2>Download</h2>
+<p>The source is available for download from
<a href="https://raw.githubusercontent.com/caolan/async/master/dist/async.min.js">GitHub</a>.
Alternatively, you can install using npm:</p>
-<pre class="prettyprint source lang-bash"><code>$ npm install async</code></pre><p>As well as using Bower:</p>
-<pre class="prettyprint source lang-bash"><code>$ bower install async</code></pre><p>You can then <code>require()</code> async as normal:</p>
-<pre class="prettyprint source lang-js"><code>var async = require(&quot;async&quot;);</code></pre><p>Or require individual methods:</p>
+<pre class="prettyprint source lang-bash"><code>$ npm i async
+</code></pre>
+<p>You can then <code>require()</code> async as normal:</p>
+<pre class="prettyprint source lang-js"><code>var async = require(&quot;async&quot;);
+</code></pre>
+<p>Or require individual methods:</p>
<pre class="prettyprint source lang-js"><code>var waterfall = require(&quot;async/waterfall&quot;);
-var map = require(&quot;async/map&quot;);</code></pre><p><strong>Development:</strong> <a href="https://raw.githubusercontent.com/caolan/async/master/dist/async.js">async.js</a> - 29.6kb Uncompressed</p>
-<h3>In the Browser</h3><p>Async should work in any ES2015 environment (Node 6+ and all modern browsers).</p>
+var map = require(&quot;async/map&quot;);
+</code></pre>
+<p><strong>Development:</strong> <a href="https://raw.githubusercontent.com/caolan/async/master/dist/async.js">async.js</a> - 29.6kb Uncompressed</p>
+<h3>In the Browser</h3>
+<p>Async should work in any ES2015 environment (Node 6+ and all modern browsers).</p>
<p>If you want to use Async in an older environment, (e.g. Node 4, IE11) you will have to transpile.</p>
<p>Usage:</p>
<pre class="prettyprint source lang-html"><code>&lt;script type=&quot;text/javascript&quot; src=&quot;async.js&quot;&gt;&lt;/script&gt;
@@ -244,12 +275,31 @@ var map = require(&quot;async/map&quot;);</code></pre><p><strong>Development:</s
alert(results);
});
-&lt;/script&gt;</code></pre><p>The portable versions of Async, including <code>async.js</code> and <code>async.min.js</code>, are
+&lt;/script&gt;
+</code></pre>
+<p>The portable versions of Async, including <code>async.js</code> and <code>async.min.js</code>, are
included in the <code>/dist</code> folder. Async can also be found on the <a href="http://www.jsdelivr.com/projects/async">jsDelivr CDN</a>.</p>
-<h3>ES Modules</h3><p>Async includes a <code>.mjs</code> version that should automatically be used by compatible bundlers such as Webpack or Rollup, anything that uses the <code>module</code> field of the <code>package.json</code>.</p>
+<h3>ES Modules</h3>
+<p>Async includes a <code>.mjs</code> version that should automatically be used by compatible bundlers such as Webpack or Rollup, anything that uses the <code>module</code> field of the <code>package.json</code>.</p>
<p>We also provide Async as a collection of purely ES2015 modules, in an alternative <code>async-es</code> package on npm.</p>
-<pre class="prettyprint source lang-bash"><code>$ npm install async-es</code></pre><pre class="prettyprint source lang-js"><code>import waterfall from &apos;async-es/waterfall&apos;;
-import async from &apos;async-es&apos;;</code></pre><h2>Other Libraries</h2><ul>
+<pre class="prettyprint source lang-bash"><code>$ npm install async-es
+</code></pre>
+<pre class="prettyprint source lang-js"><code>import waterfall from &apos;async-es/waterfall&apos;;
+import async from &apos;async-es&apos;;
+</code></pre>
+<h3>Typescript</h3>
+<p>There are third-party type definitions for Async.</p>
+<pre class="prettyprint source"><code>npm i -D @types/async
+</code></pre>
+<p>It is recommended to target ES2017 or higher in your <code>tsconfig.json</code>, so <code>async</code> functions are preserved:</p>
+<pre class="prettyprint source lang-json"><code>{
+ &quot;compilerOptions&quot;: {
+ &quot;target&quot;: &quot;es2017&quot;
+ }
+}
+</code></pre>
+<h2>Other Libraries</h2>
+<ul>
<li><a href="https://www.npmjs.com/package/limiter"><code>limiter</code></a> a package for rate-limiting based on requests per sec/hour.</li>
<li><a href="https://www.npmjs.com/package/neo-async"><code>neo-async</code></a> an altername implementation of Async, focusing on speed.</li>
<li><a href="https://www.npmjs.com/package/co-async"><code>co-async</code></a> a library inspired by Async for use with <a href="https://www.npmjs.com/package/co"><code>co</code></a> and generator functions.</li>
@@ -263,7 +313,7 @@ import async from &apos;async-es&apos;;</code></pre><h2>Other Libraries</h2><ul>
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/index.js.html b/docs/v3/index.js.html
index 0cc26c1..99d02f1 100644
--- a/docs/v3/index.js.html
+++ b/docs/v3/index.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -441,7 +441,7 @@ export {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/log.js.html b/docs/v3/log.js.html
index 2e9c07e..60c55e5 100644
--- a/docs/v3/log.js.html
+++ b/docs/v3/log.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -113,7 +113,7 @@ export default consoleFunc(&apos;log&apos;);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/map.js.html b/docs/v3/map.js.html
index eca1a4a..6940bb8 100644
--- a/docs/v3/map.js.html
+++ b/docs/v3/map.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -128,7 +128,7 @@ export default awaitify(map, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/mapLimit.js.html b/docs/v3/mapLimit.js.html
index 3231994..29edc19 100644
--- a/docs/v3/mapLimit.js.html
+++ b/docs/v3/mapLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -111,7 +111,7 @@ export default awaitify(mapLimit, 4);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/mapSeries.js.html b/docs/v3/mapSeries.js.html
index 4bddfc1..62f5f7a 100644
--- a/docs/v3/mapSeries.js.html
+++ b/docs/v3/mapSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -110,7 +110,7 @@ export default awaitify(mapSeries, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/mapValues.js.html b/docs/v3/mapValues.js.html
index 4eb1ad4..fad9463 100644
--- a/docs/v3/mapValues.js.html
+++ b/docs/v3/mapValues.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -133,7 +133,7 @@ export default function mapValues(obj, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/mapValuesLimit.js.html b/docs/v3/mapValuesLimit.js.html
index ace014a..912d4c7 100644
--- a/docs/v3/mapValuesLimit.js.html
+++ b/docs/v3/mapValuesLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -124,7 +124,7 @@ export default awaitify(mapValuesLimit, 4)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/mapValuesSeries.js.html b/docs/v3/mapValuesSeries.js.html
index ea54c16..b15b9e3 100644
--- a/docs/v3/mapValuesSeries.js.html
+++ b/docs/v3/mapValuesSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -108,7 +108,7 @@ export default function mapValuesSeries(obj, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/memoize.js.html b/docs/v3/memoize.js.html
index 08e8e78..1ce7455 100644
--- a/docs/v3/memoize.js.html
+++ b/docs/v3/memoize.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -156,7 +156,7 @@ export default function memoize(fn, hasher = v =&gt; v) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/module-Collections.html b/docs/v3/module-Collections.html
index fc7fffb..076cc7a 100644
--- a/docs/v3/module-Collections.html
+++ b/docs/v3/module-Collections.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -196,7 +196,9 @@ arrays and objects.</p></div>
<div class="description">
- <pre class="prettyprint source"><code>import concat from &apos;async/concat&apos;;</code></pre><p>Applies <code>iteratee</code> to each item in <code>coll</code>, concatenating the results. Returns
+ <pre class="prettyprint source"><code>import concat from &apos;async/concat&apos;;
+</code></pre>
+<p>Applies <code>iteratee</code> to each item in <code>coll</code>, concatenating the results. Returns
the concatenated list. The <code>iteratee</code>s are called in parallel, and the
results are concatenated as they return. The results array will be returned in
the original order of <code>coll</code> passed to the <code>iteratee</code> function.</p>
@@ -414,7 +416,9 @@ containing the concatenated results of the <code>iteratee</code> function. Invok
<div class="description">
- <pre class="prettyprint source"><code>import concatLimit from &apos;async/concatLimit&apos;;</code></pre><p>The same as <a href="docs.html#concat"><code>concat</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import concatLimit from &apos;async/concatLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#concat"><code>concat</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -652,7 +656,9 @@ containing the concatenated results of the <code>iteratee</code> function. Invok
<div class="description">
- <pre class="prettyprint source"><code>import concatSeries from &apos;async/concatSeries&apos;;</code></pre><p>The same as <a href="docs.html#concat"><code>concat</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import concatSeries from &apos;async/concatSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#concat"><code>concat</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -868,7 +874,9 @@ containing the concatenated results of the <code>iteratee</code> function. Invok
<div class="description">
- <pre class="prettyprint source"><code>import detect from &apos;async/detect&apos;;</code></pre><p>Returns the first value in <code>coll</code> that passes an async truth test. The
+ <pre class="prettyprint source"><code>import detect from &apos;async/detect&apos;;
+</code></pre>
+<p>Returns the first value in <code>coll</code> that passes an async truth test. The
<code>iteratee</code> is applied in parallel, meaning the first iteratee to return
<code>true</code> will fire the detect <code>callback</code> with that result. That means the
result might not be the first item in the original <code>coll</code> (in terms of order)
@@ -1095,7 +1103,9 @@ Result will be the first item in the array that passes the truth test
<div class="description">
- <pre class="prettyprint source"><code>import detectLimit from &apos;async/detectLimit&apos;;</code></pre><p>The same as <a href="docs.html#detect"><code>detect</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import detectLimit from &apos;async/detectLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#detect"><code>detect</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -1336,7 +1346,9 @@ Result will be the first item in the array that passes the truth test
<div class="description">
- <pre class="prettyprint source"><code>import detectSeries from &apos;async/detectSeries&apos;;</code></pre><p>The same as <a href="docs.html#detect"><code>detect</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import detectSeries from &apos;async/detectSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#detect"><code>detect</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -1553,7 +1565,9 @@ Result will be the first item in the array that passes the truth test
<div class="description">
- <pre class="prettyprint source"><code>import each from &apos;async/each&apos;;</code></pre><p>Applies the function <code>iteratee</code> to each item in <code>coll</code>, in parallel.
+ <pre class="prettyprint source"><code>import each from &apos;async/each&apos;;
+</code></pre>
+<p>Applies the function <code>iteratee</code> to each item in <code>coll</code>, in parallel.
The <code>iteratee</code> is called with an item from the list, and a callback for when
it has finished. If the <code>iteratee</code> passes an error to its <code>callback</code>, the
main <code>callback</code> (for the <code>each</code> function) is immediately called with the
@@ -1814,7 +1828,9 @@ async.each(openFiles, function(file, callback) {
<div class="description">
- <pre class="prettyprint source"><code>import eachLimit from &apos;async/eachLimit&apos;;</code></pre><p>The same as <a href="docs.html#each"><code>each</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import eachLimit from &apos;async/eachLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#each"><code>each</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -2065,7 +2081,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import eachOf from &apos;async/eachOf&apos;;</code></pre><p>Like <a href="docs.html#each"><code>each</code></a>, except that it passes the key (or index) as the second argument
+ <pre class="prettyprint source"><code>import eachOf from &apos;async/eachOf&apos;;
+</code></pre>
+<p>Like <a href="docs.html#each"><code>each</code></a>, except that it passes the key (or index) as the second argument
to the iteratee.</p>
</div>
@@ -2315,7 +2333,9 @@ async.forEachOf(obj, function (value, key, callback) {
<div class="description">
- <pre class="prettyprint source"><code>import eachOfLimit from &apos;async/eachOfLimit&apos;;</code></pre><p>The same as <a href="docs.html#eachOf"><code>eachOf</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import eachOfLimit from &apos;async/eachOfLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#eachOf"><code>eachOf</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -2566,7 +2586,9 @@ Invoked with (item, key, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import eachOfSeries from &apos;async/eachOfSeries&apos;;</code></pre><p>The same as <a href="docs.html#eachOf"><code>eachOf</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import eachOfSeries from &apos;async/eachOfSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#eachOf"><code>eachOf</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -2792,7 +2814,9 @@ functions have finished, or an error occurs. Invoked with (err).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import eachSeries from &apos;async/eachSeries&apos;;</code></pre><p>The same as <a href="docs.html#each"><code>each</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import eachSeries from &apos;async/eachSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#each"><code>each</code></a> but runs only a single async operation at a time.</p>
<p>Note, that unlike <a href="docs.html#each"><code>each</code></a>, this function applies iteratee to each item
in series and therefore the iteratee functions will complete in order.</p>
</div>
@@ -3022,7 +3046,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import every from &apos;async/every&apos;;</code></pre><p>Returns <code>true</code> if every element in <code>coll</code> satisfies an async test. If any
+ <pre class="prettyprint source"><code>import every from &apos;async/every&apos;;
+</code></pre>
+<p>Returns <code>true</code> if every element in <code>coll</code> satisfies an async test. If any
iteratee call returns <code>false</code>, the main <code>callback</code> is immediately called.</p>
</div>
@@ -3255,7 +3281,9 @@ depending on the values of the async tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import everyLimit from &apos;async/everyLimit&apos;;</code></pre><p>The same as <a href="docs.html#every"><code>every</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import everyLimit from &apos;async/everyLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#every"><code>every</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -3506,7 +3534,9 @@ depending on the values of the async tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import everySeries from &apos;async/everySeries&apos;;</code></pre><p>The same as <a href="docs.html#every"><code>every</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import everySeries from &apos;async/everySeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#every"><code>every</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -3734,7 +3764,9 @@ depending on the values of the async tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import filter from &apos;async/filter&apos;;</code></pre><p>Returns a new array of all the values in <code>coll</code> which pass an async truth
+ <pre class="prettyprint source"><code>import filter from &apos;async/filter&apos;;
+</code></pre>
+<p>Returns a new array of all the values in <code>coll</code> which pass an async truth
test. This operation is performed in parallel, but the results array will be
in the same order as the original.</p>
</div>
@@ -3966,7 +3998,9 @@ with a boolean argument once it has completed. Invoked with (item, callback).</p
<div class="description">
- <pre class="prettyprint source"><code>import filterLimit from &apos;async/filterLimit&apos;;</code></pre><p>The same as <a href="docs.html#filter"><code>filter</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import filterLimit from &apos;async/filterLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#filter"><code>filter</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -4216,7 +4250,9 @@ with a boolean argument once it has completed. Invoked with (item, callback).</p
<div class="description">
- <pre class="prettyprint source"><code>import filterSeries from &apos;async/filterSeries&apos;;</code></pre><p>The same as <a href="docs.html#filter"><code>filter</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import filterSeries from &apos;async/filterSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#filter"><code>filter</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -4442,7 +4478,9 @@ with a boolean argument once it has completed. Invoked with (item, callback).</p
<div class="description">
- <pre class="prettyprint source"><code>import groupBy from &apos;async/groupBy&apos;;</code></pre><p>Returns a new object, where each value corresponds to an array of items, from
+ <pre class="prettyprint source"><code>import groupBy from &apos;async/groupBy&apos;;
+</code></pre>
+<p>Returns a new object, where each value corresponds to an array of items, from
<code>coll</code>, that returned the corresponding key. That is, the keys of the object
correspond to the values passed to the <code>iteratee</code> callback.</p>
<p>Note: Since this function applies the <code>iteratee</code> to each item in parallel,
@@ -4678,7 +4716,9 @@ properties are arrays of values which returned the corresponding key.</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import groupByLimit from &apos;async/groupByLimit&apos;;</code></pre><p>The same as <a href="docs.html#groupBy"><code>groupBy</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import groupByLimit from &apos;async/groupByLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#groupBy"><code>groupBy</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -4924,7 +4964,9 @@ properties are arrays of values which returned the corresponding key.</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import groupBySeries from &apos;async/groupBySeries&apos;;</code></pre><p>The same as <a href="docs.html#groupBy"><code>groupBy</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import groupBySeries from &apos;async/groupBySeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#groupBy"><code>groupBy</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -5147,7 +5189,9 @@ properties are arrays of values which returned the corresponding key.</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import map from &apos;async/map&apos;;</code></pre><p>Produces a new collection of values by mapping each value in <code>coll</code> through
+ <pre class="prettyprint source"><code>import map from &apos;async/map&apos;;
+</code></pre>
+<p>Produces a new collection of values by mapping each value in <code>coll</code> through
the <code>iteratee</code> function. The <code>iteratee</code> is called with an item from <code>coll</code>
and a callback for when it has finished processing. Each of these callback
takes 2 arguments: an <code>error</code>, and the transformed item from <code>coll</code>. If
@@ -5382,7 +5426,9 @@ transformed items from the <code>coll</code>. Invoked with (err, results).</p></
<div class="description">
- <pre class="prettyprint source"><code>import mapLimit from &apos;async/mapLimit&apos;;</code></pre><p>The same as <a href="docs.html#map"><code>map</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import mapLimit from &apos;async/mapLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#map"><code>map</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -5628,7 +5674,9 @@ transformed items from the <code>coll</code>. Invoked with (err, results).</p></
<div class="description">
- <pre class="prettyprint source"><code>import mapSeries from &apos;async/mapSeries&apos;;</code></pre><p>The same as <a href="docs.html#map"><code>map</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import mapSeries from &apos;async/mapSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#map"><code>map</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -5851,7 +5899,9 @@ transformed items from the <code>coll</code>. Invoked with (err, results).</p></
<div class="description">
- <pre class="prettyprint source"><code>import mapValues from &apos;async/mapValues&apos;;</code></pre><p>A relative of <a href="docs.html#map"><code>map</code></a>, designed for use with objects.</p>
+ <pre class="prettyprint source"><code>import mapValues from &apos;async/mapValues&apos;;
+</code></pre>
+<p>A relative of <a href="docs.html#map"><code>map</code></a>, designed for use with objects.</p>
<p>Produces a new Object by mapping each value of <code>obj</code> through the <code>iteratee</code>
function. The <code>iteratee</code> is called each <code>value</code> and <code>key</code> from <code>obj</code> and a
callback for when it has finished processing. Each of these callbacks takes
@@ -6085,7 +6135,9 @@ Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import mapValuesLimit from &apos;async/mapValuesLimit&apos;;</code></pre><p>The same as <a href="docs.html#mapValues"><code>mapValues</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import mapValuesLimit from &apos;async/mapValuesLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#mapValues"><code>mapValues</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -6324,7 +6376,9 @@ Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import mapValuesSeries from &apos;async/mapValuesSeries&apos;;</code></pre><p>The same as <a href="docs.html#mapValues"><code>mapValues</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import mapValuesSeries from &apos;async/mapValuesSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#mapValues"><code>mapValues</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -6539,7 +6593,9 @@ Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import reduce from &apos;async/reduce&apos;;</code></pre><p>Reduces <code>coll</code> into a single value using an async <code>iteratee</code> to return each
+ <pre class="prettyprint source"><code>import reduce from &apos;async/reduce&apos;;
+</code></pre>
+<p>Reduces <code>coll</code> into a single value using an async <code>iteratee</code> to return each
successive step. <code>memo</code> is the initial state of the reduction. This function
only operates in series.</p>
<p>For performance reasons, it may make sense to split a call to this function
@@ -6804,7 +6860,9 @@ Invoked with (memo, item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import reduceRight from &apos;async/reduceRight&apos;;</code></pre><p>Same as <a href="docs.html#reduce"><code>reduce</code></a>, only operates on <code>array</code> in reverse order.</p>
+ <pre class="prettyprint source"><code>import reduceRight from &apos;async/reduceRight&apos;;
+</code></pre>
+<p>Same as <a href="docs.html#reduce"><code>reduce</code></a>, only operates on <code>array</code> in reverse order.</p>
</div>
@@ -7048,7 +7106,9 @@ Invoked with (memo, item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import reject from &apos;async/reject&apos;;</code></pre><p>The opposite of <a href="docs.html#filter"><code>filter</code></a>. Removes values that pass an <code>async</code> truth test.</p>
+ <pre class="prettyprint source"><code>import reject from &apos;async/reject&apos;;
+</code></pre>
+<p>The opposite of <a href="docs.html#filter"><code>filter</code></a>. Removes values that pass an <code>async</code> truth test.</p>
</div>
@@ -7282,7 +7342,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import rejectLimit from &apos;async/rejectLimit&apos;;</code></pre><p>The same as <a href="docs.html#reject"><code>reject</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import rejectLimit from &apos;async/rejectLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#reject"><code>reject</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -7528,7 +7590,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import rejectSeries from &apos;async/rejectSeries&apos;;</code></pre><p>The same as <a href="docs.html#reject"><code>reject</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import rejectSeries from &apos;async/rejectSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#reject"><code>reject</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -7750,7 +7814,9 @@ Invoked with (item, callback).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import some from &apos;async/some&apos;;</code></pre><p>Returns <code>true</code> if at least one element in the <code>coll</code> satisfies an async test.
+ <pre class="prettyprint source"><code>import some from &apos;async/some&apos;;
+</code></pre>
+<p>Returns <code>true</code> if at least one element in the <code>coll</code> satisfies an async test.
If any iteratee call returns <code>true</code>, the main <code>callback</code> is immediately
called.</p>
</div>
@@ -7985,7 +8051,9 @@ tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import someLimit from &apos;async/someLimit&apos;;</code></pre><p>The same as <a href="docs.html#some"><code>some</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
+ <pre class="prettyprint source"><code>import someLimit from &apos;async/someLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#some"><code>some</code></a> but runs a maximum of <code>limit</code> async operations at a time.</p>
</div>
@@ -8237,7 +8305,9 @@ tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import someSeries from &apos;async/someSeries&apos;;</code></pre><p>The same as <a href="docs.html#some"><code>some</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import someSeries from &apos;async/someSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#some"><code>some</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -8466,7 +8536,9 @@ tests. Invoked with (err, result).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import sortBy from &apos;async/sortBy&apos;;</code></pre><p>Sorts a list by the results of running each <code>coll</code> value through an async
+ <pre class="prettyprint source"><code>import sortBy from &apos;async/sortBy&apos;;
+</code></pre>
+<p>Sorts a list by the results of running each <code>coll</code> value through an async
<code>iteratee</code>.</p>
</div>
@@ -8712,7 +8784,9 @@ async.sortBy([1,9,3,5], function(x, callback) {
<div class="description">
- <pre class="prettyprint source"><code>import transform from &apos;async/transform&apos;;</code></pre><p>A relative of <code>reduce</code>. Takes an Object or Array, and iterates over each
+ <pre class="prettyprint source"><code>import transform from &apos;async/transform&apos;;
+</code></pre>
+<p>A relative of <code>reduce</code>. Takes an Object or Array, and iterates over each
element in parallel, each step potentially mutating an <code>accumulator</code> value.
The type of the accumulator defaults to the type of collection passed in.</p>
</div>
@@ -8979,7 +9053,7 @@ Invoked with (err, result).</p></td>
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/module-ControlFlow.html b/docs/v3/module-ControlFlow.html
index ed1ff8e..b32fb92 100644
--- a/docs/v3/module-ControlFlow.html
+++ b/docs/v3/module-ControlFlow.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -195,7 +195,9 @@
<div class="description">
- <pre class="prettyprint source"><code>import applyEach from &apos;async/applyEach&apos;;</code></pre><p>Applies the provided arguments to each function in the array, calling
+ <pre class="prettyprint source"><code>import applyEach from &apos;async/applyEach&apos;;
+</code></pre>
+<p>Applies the provided arguments to each function in the array, calling
<code>callback</code> after all functions have completed. If you only provide the first
argument, <code>fns</code>, then it will return a function which lets you pass in the
arguments as if it were a single function call. If more arguments are
@@ -438,7 +440,9 @@ async.each(
<div class="description">
- <pre class="prettyprint source"><code>import applyEachSeries from &apos;async/applyEachSeries&apos;;</code></pre><p>The same as <a href="docs.html#applyEach"><code>applyEach</code></a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import applyEachSeries from &apos;async/applyEachSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#applyEach"><code>applyEach</code></a> but runs only a single async operation at a time.</p>
</div>
@@ -665,7 +669,9 @@ a callback.</li>
<div class="description">
- <pre class="prettyprint source"><code>import auto from &apos;async/auto&apos;;</code></pre><p>Determines the best order for running the <a href="global.html">AsyncFunction</a>s in <code>tasks</code>, based on
+ <pre class="prettyprint source"><code>import auto from &apos;async/auto&apos;;
+</code></pre>
+<p>Determines the best order for running the <a href="global.html">AsyncFunction</a>s in <code>tasks</code>, based on
their requirements. Each function can optionally depend on other functions
being completed first, and each function is run as soon as its requirements
are satisfied.</p>
@@ -953,7 +959,9 @@ async.auto({
<div class="description">
- <pre class="prettyprint source"><code>import autoInject from &apos;async/autoInject&apos;;</code></pre><p>A dependency-injected version of the <a href="docs.html#auto">async.auto</a> function. Dependent
+ <pre class="prettyprint source"><code>import autoInject from &apos;async/autoInject&apos;;
+</code></pre>
+<p>A dependency-injected version of the <a href="docs.html#auto">async.auto</a> function. Dependent
tasks are specified as parameters to the function, after the usual callback
parameter, with the parameter names matching the names of the tasks it
depends on. This can provide even more readable task graphs which can be
@@ -1211,7 +1219,9 @@ async.autoInject({
<div class="description">
- <pre class="prettyprint source"><code>import cargo from &apos;async/cargo&apos;;</code></pre><p>Creates a <code>cargo</code> object with the specified payload. Tasks added to the
+ <pre class="prettyprint source"><code>import cargo from &apos;async/cargo&apos;;
+</code></pre>
+<p>Creates a <code>cargo</code> object with the specified payload. Tasks added to the
cargo will be processed altogether (up to the <code>payload</code> limit). If the
<code>worker</code> is in progress, the task is queued until it becomes available. Once
the <code>worker</code> has completed some tasks, each callback of those tasks is
@@ -1443,7 +1453,9 @@ console.log(&apos;finished processing baz&apos;);</code></pre>
<div class="description">
- <pre class="prettyprint source"><code>import cargoQueue from &apos;async/cargoQueue&apos;;</code></pre><p>Creates a <code>cargoQueue</code> object with the specified payload. Tasks added to the
+ <pre class="prettyprint source"><code>import cargoQueue from &apos;async/cargoQueue&apos;;
+</code></pre>
+<p>Creates a <code>cargoQueue</code> object with the specified payload. Tasks added to the
cargoQueue will be processed together (up to the <code>payload</code> limit) in <code>concurrency</code> parallel workers.
If the all <code>workers</code> are in progress, the task is queued until one becomes available. Once
a <code>worker</code> has completed some tasks, each callback of those tasks is
@@ -1714,7 +1726,9 @@ cargoQueue.push({name: &apos;boo&apos;}, function(err) {
<div class="description">
- <pre class="prettyprint source"><code>import compose from &apos;async/compose&apos;;</code></pre><p>Creates a function which is a composition of the passed asynchronous
+ <pre class="prettyprint source"><code>import compose from &apos;async/compose&apos;;
+</code></pre>
+<p>Creates a function which is a composition of the passed asynchronous
functions. Each function consumes the return value of the function that
follows. Composing functions <code>f()</code>, <code>g()</code>, and <code>h()</code> would produce the result
of <code>f(g(h()))</code>, only this version uses callbacks to obtain the return values.</p>
@@ -1895,7 +1909,9 @@ add1mul3(4, function (err, result) {
<div class="description">
- <pre class="prettyprint source"><code>import doUntil from &apos;async/doUntil&apos;;</code></pre><p>Like <a href="docs.html#doWhilst">&apos;doWhilst&apos;</a>, except the <code>test</code> is inverted. Note the
+ <pre class="prettyprint source"><code>import doUntil from &apos;async/doUntil&apos;;
+</code></pre>
+<p>Like <a href="docs.html#doWhilst">&apos;doWhilst&apos;</a>, except the <code>test</code> is inverted. Note the
argument ordering differs from <code>until</code>.</p>
</div>
@@ -2111,7 +2127,9 @@ callback. Invoked with (err, [results]);</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import doWhilst from &apos;async/doWhilst&apos;;</code></pre><p>The post-check version of <a href="docs.html#whilst"><code>whilst</code></a>. To reflect the difference in
+ <pre class="prettyprint source"><code>import doWhilst from &apos;async/doWhilst&apos;;
+</code></pre>
+<p>The post-check version of <a href="docs.html#whilst"><code>whilst</code></a>. To reflect the difference in
the order of operations, the arguments <code>test</code> and <code>iteratee</code> are switched.</p>
<p><code>doWhilst</code> is to <code>whilst</code> as <code>do while</code> is to <code>while</code> in plain JavaScript.</p>
</div>
@@ -2328,7 +2346,9 @@ function has failed and repeated execution of <code>iteratee</code> has stopped.
<div class="description">
- <pre class="prettyprint source"><code>import forever from &apos;async/forever&apos;;</code></pre><p>Calls the asynchronous function <code>fn</code> with a callback parameter that allows it
+ <pre class="prettyprint source"><code>import forever from &apos;async/forever&apos;;
+</code></pre>
+<p>Calls the asynchronous function <code>fn</code> with a callback parameter that allows it
to call itself again, in series, indefinitely.
If an error is passed to the callback then <code>errback</code> is called with the
error, and execution stops, otherwise it will never be called.</p>
@@ -2527,7 +2547,9 @@ is not passed</p>
<div class="description">
- <pre class="prettyprint source"><code>import parallel from &apos;async/parallel&apos;;</code></pre><p>Run the <code>tasks</code> collection of functions in parallel, without waiting until
+ <pre class="prettyprint source"><code>import parallel from &apos;async/parallel&apos;;
+</code></pre>
+<p>Run the <code>tasks</code> collection of functions in parallel, without waiting until
the previous function has completed. If any of the functions pass an error to
its callback, the main <code>callback</code> is immediately called with the value of the
error. Once the <code>tasks</code> have completed, the results are passed to the final
@@ -2772,7 +2794,9 @@ async.parallel({
<div class="description">
- <pre class="prettyprint source"><code>import parallelLimit from &apos;async/parallelLimit&apos;;</code></pre><p>The same as <a href="docs.html#parallel"><code>parallel</code></a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import parallelLimit from &apos;async/parallelLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#parallel"><code>parallel</code></a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -2996,7 +3020,9 @@ Invoked with (err, results).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import priorityQueue from &apos;async/priorityQueue&apos;;</code></pre><p>The same as <a href="docs.html#queue">async.queue</a> only tasks are assigned a priority and
+ <pre class="prettyprint source"><code>import priorityQueue from &apos;async/priorityQueue&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#queue">async.queue</a> only tasks are assigned a priority and
completed in ascending priority order.</p>
</div>
@@ -3192,7 +3218,9 @@ array of <code>tasks</code> is given, all tasks will be assigned the same priori
<div class="description">
- <pre class="prettyprint source"><code>import queue from &apos;async/queue&apos;;</code></pre><p>Creates a <code>queue</code> object with the specified <code>concurrency</code>. Tasks added to the
+ <pre class="prettyprint source"><code>import queue from &apos;async/queue&apos;;
+</code></pre>
+<p>Creates a <code>queue</code> object with the specified <code>concurrency</code>. Tasks added to the
<code>queue</code> are processed in parallel (up to the <code>concurrency</code> limit). If all
<code>worker</code>s are in progress, the task is queued until one becomes available.
Once a <code>worker</code> completes a <code>task</code>, that <code>task</code>&apos;s callback is called.</p>
@@ -3396,7 +3424,7 @@ q.unshift({name: &apos;bar&apos;}, function (err) {
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="queue.js.html">queue.js</a>, <a href="queue.js.html#line85">line 85</a>
+ <a href="queue.js.html">queue.js</a>, <a href="queue.js.html#line89">line 89</a>
</li></ul></dd>
@@ -3430,7 +3458,9 @@ q.unshift({name: &apos;bar&apos;}, function (err) {
<div class="description">
- <pre class="prettyprint source"><code>import race from &apos;async/race&apos;;</code></pre><p>Runs the <code>tasks</code> array of functions in parallel, without waiting until the
+ <pre class="prettyprint source"><code>import race from &apos;async/race&apos;;
+</code></pre>
+<p>Runs the <code>tasks</code> array of functions in parallel, without waiting until the
previous function has completed. Once any of the <code>tasks</code> complete or pass an
error to its callback, the main <code>callback</code> is immediately called. It&apos;s
equivalent to <code>Promise.race()</code>.</p>
@@ -3621,7 +3651,9 @@ function(err, result) {
<div class="description">
- <pre class="prettyprint source"><code>import retry from &apos;async/retry&apos;;</code></pre><p>Attempts to get a successful response from <code>task</code> no more than <code>times</code> times
+ <pre class="prettyprint source"><code>import retry from &apos;async/retry&apos;;
+</code></pre>
+<p>Attempts to get a successful response from <code>task</code> no more than <code>times</code> times
before returning an error. If the task is successful, the <code>callback</code> will be
passed the result of the successful task. If all attempts fail, the callback
will be passed the error and result (if any) of the final attempt.</p>
@@ -3924,7 +3956,9 @@ async.auto({
<div class="description">
- <pre class="prettyprint source"><code>import retryable from &apos;async/retryable&apos;;</code></pre><p>A close relative of <a href="docs.html#retry"><code>retry</code></a>. This method
+ <pre class="prettyprint source"><code>import retryable from &apos;async/retryable&apos;;
+</code></pre>
+<p>A close relative of <a href="docs.html#retry"><code>retry</code></a>. This method
wraps a task and makes it retryable, rather than immediately calling it
with retries.</p>
</div>
@@ -4143,7 +4177,9 @@ This function will accept the same parameters as <code>task</code>.</p>
<div class="description">
- <pre class="prettyprint source"><code>import seq from &apos;async/seq&apos;;</code></pre><p>Version of the compose function that is more natural to read. Each function
+ <pre class="prettyprint source"><code>import seq from &apos;async/seq&apos;;
+</code></pre>
+<p>Version of the compose function that is more natural to read. Each function
consumes the return value of the previous function. It is the equivalent of
<a href="docs.html#compose">compose</a> with the arguments reversed.</p>
<p>Each function is executed with the <code>this</code> binding of the composed function.</p>
@@ -4331,7 +4367,9 @@ app.get(&apos;/cats&apos;, function(request, response) {
<div class="description">
- <pre class="prettyprint source"><code>import series from &apos;async/series&apos;;</code></pre><p>Run the functions in the <code>tasks</code> collection in series, each one running once
+ <pre class="prettyprint source"><code>import series from &apos;async/series&apos;;
+</code></pre>
+<p>Run the functions in the <code>tasks</code> collection in series, each one running once
the previous function has completed. If any functions in the series pass an
error to its callback, no more functions are run, and <code>callback</code> is
immediately called with the value of the error. Otherwise, <code>callback</code>
@@ -4339,7 +4377,7 @@ receives an array of results when <code>tasks</code> have completed.</p>
<p>It is also possible to use an object instead of an array. Each property will
be run as a function, and the results will be passed to the final <code>callback</code>
as an object instead of an array. This can be a more readable way of handling
- results from async.series.</p>
+results from async.series.</p>
<p><strong>Note</strong> that while many implementations preserve the order of object
properties, the <a href="http://www.ecma-international.org/ecma-262/5.1/#sec-8.6">ECMAScript Language Specification</a>
explicitly states that</p>
@@ -4573,7 +4611,9 @@ async.series({
<div class="description">
- <pre class="prettyprint source"><code>import times from &apos;async/times&apos;;</code></pre><p>Calls the <code>iteratee</code> function <code>n</code> times, and accumulates results in the same
+ <pre class="prettyprint source"><code>import times from &apos;async/times&apos;;
+</code></pre>
+<p>Calls the <code>iteratee</code> function <code>n</code> times, and accumulates results in the same
manner you would use with <a href="docs.html#map">map</a>.</p>
</div>
@@ -4801,7 +4841,9 @@ async.times(5, function(n, next) {
<div class="description">
- <pre class="prettyprint source"><code>import timesLimit from &apos;async/timesLimit&apos;;</code></pre><p>The same as <a href="docs.html#times">times</a> but runs a maximum of <code>limit</code> async operations at a
+ <pre class="prettyprint source"><code>import timesLimit from &apos;async/timesLimit&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#times">times</a> but runs a maximum of <code>limit</code> async operations at a
time.</p>
</div>
@@ -5033,7 +5075,9 @@ Invoked with the iteration index and a callback: (n, next).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import timesSeries from &apos;async/timesSeries&apos;;</code></pre><p>The same as <a href="docs.html#times">times</a> but runs only a single async operation at a time.</p>
+ <pre class="prettyprint source"><code>import timesSeries from &apos;async/timesSeries&apos;;
+</code></pre>
+<p>The same as <a href="docs.html#times">times</a> but runs only a single async operation at a time.</p>
</div>
@@ -5241,7 +5285,9 @@ Invoked with the iteration index and a callback: (n, next).</p></td>
<div class="description">
- <pre class="prettyprint source"><code>import tryEach from &apos;async/tryEach&apos;;</code></pre><p>It runs each task in series but stops whenever any of the functions were
+ <pre class="prettyprint source"><code>import tryEach from &apos;async/tryEach&apos;;
+</code></pre>
+<p>It runs each task in series but stops whenever any of the functions were
successful. If one of the tasks were successful, the <code>callback</code> will be
passed the result of the successful task. If all tasks fail, the callback
will be passed the error and result (if any) of the final attempt.</p>
@@ -5457,7 +5503,9 @@ function(err, results) {
<div class="description">
- <pre class="prettyprint source"><code>import until from &apos;async/until&apos;;</code></pre><p>Repeatedly call <code>iteratee</code> until <code>test</code> returns <code>true</code>. Calls <code>callback</code> when
+ <pre class="prettyprint source"><code>import until from &apos;async/until&apos;;
+</code></pre>
+<p>Repeatedly call <code>iteratee</code> until <code>test</code> returns <code>true</code>. Calls <code>callback</code> when
stopped, or an error occurs. <code>callback</code> will be passed an error and any
arguments passed to the final <code>iteratee</code>&apos;s callback.</p>
<p>The inverse of <a href="docs.html#whilst">whilst</a>.</p>
@@ -5690,7 +5738,9 @@ async.until(function test(page, cb) {
<div class="description">
- <pre class="prettyprint source"><code>import waterfall from &apos;async/waterfall&apos;;</code></pre><p>Runs the <code>tasks</code> array of functions in series, each passing their results to
+ <pre class="prettyprint source"><code>import waterfall from &apos;async/waterfall&apos;;
+</code></pre>
+<p>Runs the <code>tasks</code> array of functions in series, each passing their results to
the next in the array. However, if any of the <code>tasks</code> pass an error to their
own callback, the next function is not executed, and the main <code>callback</code> is
immediately called with the error.</p>
@@ -5904,7 +5954,9 @@ function myLastFunction(arg1, callback) {
<div class="description">
- <pre class="prettyprint source"><code>import whilst from &apos;async/whilst&apos;;</code></pre><p>Repeatedly call <code>iteratee</code>, while <code>test</code> returns <code>true</code>. Calls <code>callback</code> when
+ <pre class="prettyprint source"><code>import whilst from &apos;async/whilst&apos;;
+</code></pre>
+<p>Repeatedly call <code>iteratee</code>, while <code>test</code> returns <code>true</code>. Calls <code>callback</code> when
stopped, or an error occurs.</p>
</div>
@@ -6131,7 +6183,9 @@ async.whilst(
<div class="description">
- <pre class="prettyprint source"><code>import queue from &apos;async/queue&apos;;</code></pre><p>A queue of tasks for the worker function to complete.</p>
+ <pre class="prettyprint source"><code>import queue from &apos;async/queue&apos;;
+</code></pre>
+<p>A queue of tasks for the worker function to complete.</p>
</div>
@@ -6352,7 +6406,7 @@ passed to the worker function at a time. only applies if this is a
<td class="type">
-<span class="param-type">function</span>
+<span class="param-type"><a href="global.html">AsyncFunction</a></span>
@@ -6378,7 +6432,7 @@ task in the list. Invoke with <code>queue.push(task, [callback])</code>,</p></td
<td class="type">
-<span class="param-type">function</span>
+<span class="param-type"><a href="global.html">AsyncFunction</a></span>
@@ -6396,6 +6450,54 @@ Invoke with <code>queue.unshift(task, [callback])</code>.</p></td>
<tr>
+ <td class="name"><code>pushAsync</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="global.html">AsyncFunction</a></span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the same as <code>q.push</code>, except this returns
+a promise that rejects if an error occurs.</p></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>unshirtAsync</code></td>
+
+
+ <td class="type">
+
+
+<span class="param-type"><a href="global.html">AsyncFunction</a></span>
+
+
+
+ </td>
+
+
+
+
+
+ <td class="description last"><p>the same as <code>q.unshift</code>, except this returns
+a promise that rejects if an error occurs.</p></td>
+ </tr>
+
+
+
+ <tr>
+
<td class="name"><code>remove</code></td>
@@ -6753,7 +6855,7 @@ await q.drain()</code></pre>
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/module-Utils.html b/docs/v3/module-Utils.html
index aab7b21..8f3a486 100644
--- a/docs/v3/module-Utils.html
+++ b/docs/v3/module-Utils.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -195,7 +195,9 @@
<div class="description">
- <pre class="prettyprint source"><code>import apply from &apos;async/apply&apos;;</code></pre><p>Creates a continuation function with some arguments already applied.</p>
+ <pre class="prettyprint source"><code>import apply from &apos;async/apply&apos;;
+</code></pre>
+<p>Creates a continuation function with some arguments already applied.</p>
<p>Useful as a shorthand when combined with other control flow functions. Any
arguments passed to the returned function are added to the arguments
originally passed to apply.</p>
@@ -406,7 +408,9 @@ three</code></pre>
<div class="description">
- <pre class="prettyprint source"><code>import asyncify from &apos;async/asyncify&apos;;</code></pre><p>Take a sync function and make it async, passing its return value to a
+ <pre class="prettyprint source"><code>import asyncify from &apos;async/asyncify&apos;;
+</code></pre>
+<p>Take a sync function and make it async, passing its return value to a
callback. This is useful for plugging sync functions into a waterfall,
series, or other async functions. Any arguments passed to the generated
function will be passed to the wrapped function (except for the final
@@ -609,7 +613,9 @@ q.push(files);</code></pre>
<div class="description">
- <pre class="prettyprint source"><code>import constant from &apos;async/constant&apos;;</code></pre><p>Returns a function that when called, calls-back with the values provided.
+ <pre class="prettyprint source"><code>import constant from &apos;async/constant&apos;;
+</code></pre>
+<p>Returns a function that when called, calls-back with the values provided.
Useful as the first function in a <a href="docs.html#waterfall"><code>waterfall</code></a>, or for plugging values in to
<a href="docs.html#auto"><code>auto</code></a>.</p>
</div>
@@ -796,7 +802,9 @@ async.auto({
<div class="description">
- <pre class="prettyprint source"><code>import dir from &apos;async/dir&apos;;</code></pre><p>Logs the result of an <a href="global.html"><code>async</code> function</a> to the
+ <pre class="prettyprint source"><code>import dir from &apos;async/dir&apos;;
+</code></pre>
+<p>Logs the result of an <a href="global.html"><code>async</code> function</a> to the
<code>console</code> using <code>console.dir</code> to display the properties of the resulting object.
Only works in Node.js or in browsers that support <code>console.dir</code> and
<code>console.error</code> (such as FF and Chrome).
@@ -971,7 +979,9 @@ node&gt; async.dir(hello, &apos;world&apos;);
<div class="description">
- <pre class="prettyprint source"><code>import ensureAsync from &apos;async/ensureAsync&apos;;</code></pre><p>Wrap an async function and ensure it calls its callback on a later tick of
+ <pre class="prettyprint source"><code>import ensureAsync from &apos;async/ensureAsync&apos;;
+</code></pre>
+<p>Wrap an async function and ensure it calls its callback on a later tick of
the event loop. If the function already calls its callback on a next tick,
no extra deferral is added. This is useful for preventing stack overflows
(<code>RangeError: Maximum call stack size exceeded</code>) and generally keeping
@@ -1151,7 +1161,9 @@ async.mapSeries(args, async.ensureAsync(sometimesAsync), done);</code></pre>
<div class="description">
- <pre class="prettyprint source"><code>import log from &apos;async/log&apos;;</code></pre><p>Logs the result of an <code>async</code> function to the <code>console</code>. Only works in
+ <pre class="prettyprint source"><code>import log from &apos;async/log&apos;;
+</code></pre>
+<p>Logs the result of an <code>async</code> function to the <code>console</code>. Only works in
Node.js or in browsers that support <code>console.log</code> and <code>console.error</code> (such
as FF and Chrome). If multiple arguments are returned from the async
function, <code>console.log</code> is called on each argument in order.</p>
@@ -1324,7 +1336,9 @@ node&gt; async.log(hello, &apos;world&apos;);
<div class="description">
- <pre class="prettyprint source"><code>import memoize from &apos;async/memoize&apos;;</code></pre><p>Caches the results of an async function. When creating a hash to store
+ <pre class="prettyprint source"><code>import memoize from &apos;async/memoize&apos;;
+</code></pre>
+<p>Caches the results of an async function. When creating a hash to store
function results against, the callback is omitted from the hash and an
optional hash function can be used.</p>
<p><strong>Note: if the async function errs, the result will not be cached and
@@ -1528,7 +1542,9 @@ fn(&apos;some name&apos;, function() {
<div class="description">
- <pre class="prettyprint source"><code>import nextTick from &apos;async/nextTick&apos;;</code></pre><p>Calls <code>callback</code> on a later loop around the event loop. In Node.js this just
+ <pre class="prettyprint source"><code>import nextTick from &apos;async/nextTick&apos;;
+</code></pre>
+<p>Calls <code>callback</code> on a later loop around the event loop. In Node.js this just
calls <code>process.nextTick</code>. In the browser it will use <code>setImmediate</code> if
available, otherwise <code>setTimeout(callback, 0)</code>, which means other higher
priority events may precede the execution of <code>callback</code>.</p>
@@ -1710,7 +1726,9 @@ async.setImmediate(function (a, b, c) {
<div class="description">
- <pre class="prettyprint source"><code>import reflect from &apos;async/reflect&apos;;</code></pre><p>Wraps the async function in another function that always completes with a
+ <pre class="prettyprint source"><code>import reflect from &apos;async/reflect&apos;;
+</code></pre>
+<p>Wraps the async function in another function that always completes with a
result object, even when it errors.</p>
<p>The result object has either the property <code>error</code> or <code>value</code>.</p>
</div>
@@ -1895,7 +1913,9 @@ function(err, results) {
<div class="description">
- <pre class="prettyprint source"><code>import reflectAll from &apos;async/reflectAll&apos;;</code></pre><p>A helper function that wraps an array or an object of functions with <code>reflect</code>.</p>
+ <pre class="prettyprint source"><code>import reflectAll from &apos;async/reflectAll&apos;;
+</code></pre>
+<p>A helper function that wraps an array or an object of functions with <code>reflect</code>.</p>
</div>
@@ -2119,7 +2139,9 @@ function(err, results) {
<div class="description">
- <pre class="prettyprint source"><code>import setImmediate from &apos;async/setImmediate&apos;;</code></pre><p>Calls <code>callback</code> on a later loop around the event loop. In Node.js this just
+ <pre class="prettyprint source"><code>import setImmediate from &apos;async/setImmediate&apos;;
+</code></pre>
+<p>Calls <code>callback</code> on a later loop around the event loop. In Node.js this just
calls <code>setImmediate</code>. In the browser it will use <code>setImmediate</code> if
available, otherwise <code>setTimeout(callback, 0)</code>, which means other higher
priority events may precede the execution of <code>callback</code>.</p>
@@ -2301,7 +2323,9 @@ async.setImmediate(function (a, b, c) {
<div class="description">
- <pre class="prettyprint source"><code>import timeout from &apos;async/timeout&apos;;</code></pre><p>Sets a time limit on an asynchronous function. If the function does not call
+ <pre class="prettyprint source"><code>import timeout from &apos;async/timeout&apos;;
+</code></pre>
+<p>Sets a time limit on an asynchronous function. If the function does not call
its callback within the specified milliseconds, it will be called with a
timeout error. The code property for the error object will be <code>&apos;ETIMEDOUT&apos;</code>.</p>
</div>
@@ -2533,7 +2557,9 @@ wrapped({ bar: &apos;bar&apos; }, function(err, data) {
<div class="description">
- <pre class="prettyprint source"><code>import unmemoize from &apos;async/unmemoize&apos;;</code></pre><p>Undoes a <a href="docs.html#memoize">memoize</a>d function, reverting it to the original,
+ <pre class="prettyprint source"><code>import unmemoize from &apos;async/unmemoize&apos;;
+</code></pre>
+<p>Undoes a <a href="docs.html#memoize">memoize</a>d function, reverting it to the original,
unmemoized form. Handy for testing.</p>
</div>
@@ -2697,7 +2723,7 @@ unmemoized form. Handy for testing.</p>
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/module-async.html b/docs/v3/module-async.html
index 04849bf..353d4ba 100644
--- a/docs/v3/module-async.html
+++ b/docs/v3/module-async.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -203,7 +203,7 @@ use with <a href="http://nodejs.org">Node.js</a> and installable via
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/nextTick.js.html b/docs/v3/nextTick.js.html
index 72f8b16..1ba67dc 100644
--- a/docs/v3/nextTick.js.html
+++ b/docs/v3/nextTick.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -76,7 +76,7 @@
<section>
<article>
<pre class="prettyprint source linenums"><code>&apos;use strict&apos;;
-
+/* istanbul ignore file */
import { hasNextTick, hasSetImmediate, fallback, wrap } from &apos;./internal/setImmediate&apos;;
/**
@@ -129,7 +129,7 @@ export default wrap(_defer);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/parallel.js.html b/docs/v3/parallel.js.html
index 7195dde..0384300 100644
--- a/docs/v3/parallel.js.html
+++ b/docs/v3/parallel.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -159,7 +159,7 @@ export default function parallel(tasks, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/parallelLimit.js.html b/docs/v3/parallelLimit.js.html
index 670f003..10a83cf 100644
--- a/docs/v3/parallelLimit.js.html
+++ b/docs/v3/parallelLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -109,7 +109,7 @@ export default function parallelLimit(tasks, limit, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/priorityQueue.js.html b/docs/v3/priorityQueue.js.html
index dab9ff7..c8886aa 100644
--- a/docs/v3/priorityQueue.js.html
+++ b/docs/v3/priorityQueue.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -148,7 +148,7 @@ export default function(worker, concurrency) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/queue.js.html b/docs/v3/queue.js.html
index 50bf02c..bda7d45 100644
--- a/docs/v3/queue.js.html
+++ b/docs/v3/queue.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -98,12 +98,16 @@ import wrapAsync from &apos;./internal/wrapAsync&apos;;
* @property {number} payload - an integer that specifies how many items are
* passed to the worker function at a time. only applies if this is a
* [cargo]{@link module:ControlFlow.cargo} object
- * @property {Function} push - add a new task to the `queue`. Calls `callback`
+ * @property {AsyncFunction} push - add a new task to the `queue`. Calls `callback`
* once the `worker` has finished processing the task. Instead of a single task,
* a `tasks` array can be submitted. The respective callback is used for every
* task in the list. Invoke with `queue.push(task, [callback])`,
- * @property {Function} unshift - add a new task to the front of the `queue`.
+ * @property {AsyncFunction} unshift - add a new task to the front of the `queue`.
* Invoke with `queue.unshift(task, [callback])`.
+ * @property {AsyncFunction} pushAsync - the same as `q.push`, except this returns
+ * a promise that rejects if an error occurs.
+ * @property {AsyncFunction} unshirtAsync - the same as `q.unshift`, except this returns
+ * a promise that rejects if an error occurs.
* @property {Function} remove - remove items from the queue that match a test
* function. The test function will be passed an object with a `data` property,
* and a `priority` property, if this is a
@@ -230,7 +234,7 @@ export default function (worker, concurrency) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/race.js.html b/docs/v3/race.js.html
index b987e00..1777853 100644
--- a/docs/v3/race.js.html
+++ b/docs/v3/race.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -133,7 +133,7 @@ export default awaitify(race, 2)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/reduce.js.html b/docs/v3/reduce.js.html
index 9b51cc7..fe9324a 100644
--- a/docs/v3/reduce.js.html
+++ b/docs/v3/reduce.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -141,7 +141,7 @@ export default awaitify(reduce, 4)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/reduceRight.js.html b/docs/v3/reduceRight.js.html
index aecb6e8..49e0702 100644
--- a/docs/v3/reduceRight.js.html
+++ b/docs/v3/reduceRight.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -112,7 +112,7 @@ export default function reduceRight (array, memo, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/reflect.js.html b/docs/v3/reflect.js.html
index 8edac91..6d31477 100644
--- a/docs/v3/reflect.js.html
+++ b/docs/v3/reflect.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -146,7 +146,7 @@ export default function reflect(fn) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/reflectAll.js.html b/docs/v3/reflectAll.js.html
index 2184d08..9f61eaa 100644
--- a/docs/v3/reflectAll.js.html
+++ b/docs/v3/reflectAll.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -164,7 +164,7 @@ export default function reflectAll(tasks) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/reject.js.html b/docs/v3/reject.js.html
index 549a585..12f1872 100644
--- a/docs/v3/reject.js.html
+++ b/docs/v3/reject.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -119,7 +119,7 @@ export default awaitify(reject, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/rejectLimit.js.html b/docs/v3/rejectLimit.js.html
index a3b17d1..d26d00d 100644
--- a/docs/v3/rejectLimit.js.html
+++ b/docs/v3/rejectLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -110,7 +110,7 @@ export default awaitify(rejectLimit, 4);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/rejectSeries.js.html b/docs/v3/rejectSeries.js.html
index 33186ea..cb21e93 100644
--- a/docs/v3/rejectSeries.js.html
+++ b/docs/v3/rejectSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -109,7 +109,7 @@ export default awaitify(rejectSeries, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/retry.js.html b/docs/v3/retry.js.html
index 3f7e58b..24e54eb 100644
--- a/docs/v3/retry.js.html
+++ b/docs/v3/retry.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -233,7 +233,7 @@ function parseTimes(acc, t) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/retryable.js.html b/docs/v3/retryable.js.html
index 9efe7fe..2928f15 100644
--- a/docs/v3/retryable.js.html
+++ b/docs/v3/retryable.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -142,7 +142,7 @@ export default function retryable (opts, task) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/scripts/async.js b/docs/v3/scripts/async.js
index d58e1f6..b8c3504 100644
--- a/docs/v3/scripts/async.js
+++ b/docs/v3/scripts/async.js
@@ -60,6 +60,8 @@
};
}
+ /* istanbul ignore file */
+
var hasSetImmediate = typeof setImmediate === 'function' && setImmediate;
var hasNextTick = typeof process === 'object' && typeof process.nextTick === 'function';
@@ -216,6 +218,7 @@
}
Object.defineProperty(awaitable, 'name', {
+ configurable: true, // allows redefining
value: `awaitable(${asyncFn.name})`
});
@@ -617,13 +620,14 @@
* function.
* @param {Function} [callback] - the final argument should be the callback,
* called when all functions have completed processing.
- * @returns {Function} - If only the first argument, `fns`, is provided, it will
- * return a function which lets you pass in the arguments as if it were a single
- * function call. The signature is `(..args, callback)`. If invoked with any
- * arguments, `callback` is required.
+ * @returns {AsyncFunction} - Returns a function that takes no args other than
+ * an optional callback, that is the result of applying the `args` to each
+ * of the functions.
* @example
*
- * async.applyEach([enableSearch, updateSchema], 'bucket', (err, results) => {
+ * const appliedFn = async.applyEach([enableSearch, updateSchema], 'bucket')
+ *
+ * appliedFn((err, results) => {
* // results[0] is the results for `enableSearch`
* // results[1] is the results for `updateSchema`
* });
@@ -631,7 +635,7 @@
* // partial application example:
* async.each(
* buckets,
- * async.applyEach([enableSearch, updateSchema]),
+ * async (bucket) => async.applyEach([enableSearch, updateSchema], bucket)(),
* callback
* );
*/
@@ -699,9 +703,9 @@
* function.
* @param {Function} [callback] - the final argument should be the callback,
* called when all functions have completed processing.
- * @returns {Function} - If only the first argument is provided, it will return
- * a function which lets you pass in the arguments as if it were a single
- * function call.
+ * @returns {AsyncFunction} - A function, that when called, is the result of
+ * appling the `args` to the list of functions. It takes no args, other than
+ * a callback.
*/
var applyEachSeries = applyEach(mapSeries$1);
@@ -973,8 +977,8 @@
return callback[PROMISE_SYMBOL]
}
- var FN_ARGS = /^(?:async\s+)?(?:function)?\s*[^(]*\(\s*([^)]+)\s*\)(?:\s*{)/m;
- var ARROW_FN_ARGS = /^(?:async\s+)?(?:function\s+)?\(?\s*([^)^=]+)\s*\)?(?:\s*=>)/m;
+ var FN_ARGS = /^(?:async\s+)?(?:function)?\s*\w*\s*\(\s*([^)]+)\s*\)(?:\s*{)/;
+ var ARROW_FN_ARGS = /^(?:async\s+)?\(?\s*([^)=]+)\s*\)?(?:\s*=>)/;
var FN_ARG_SPLIT = /,/;
var FN_ARG = /(=.+)?(\s*)$/;
var STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg;
@@ -1251,27 +1255,26 @@
}
var processingScheduled = false;
- function _insert(data, insertAtFront, callback) {
+ function _insert(data, insertAtFront, rejectOnError, callback) {
if (callback != null && typeof callback !== 'function') {
throw new Error('task callback must be a function');
}
q.started = true;
- /*if (Array.isArray(data)) {
-
- return data.map(datum => _insert(datum, insertAtFront, callback));
- }*/
- var res;
+ var res, rej;
+ function promiseCallback (err, ...args) {
+ // we don't care about the error, let the global error handler
+ // deal with it
+ if (err) return rejectOnError ? rej(err) : res()
+ if (args.length <= 1) return res(args[0])
+ res(args);
+ }
var item = {
data,
- callback: callback || function (err, ...args) {
- // we don't care about the error, let the global error handler
- // deal with it
- if (err) return
- if (args.length <= 1) return res(args[0])
- res(args);
- }
+ callback: rejectOnError ?
+ promiseCallback :
+ (callback || promiseCallback)
};
if (insertAtFront) {
@@ -1288,9 +1291,10 @@
});
}
- if (!callback) {
- return new Promise((resolve) => {
+ if (rejectOnError || !callback) {
+ return new Promise((resolve, reject) => {
res = resolve;
+ rej = reject;
})
}
}
@@ -1327,6 +1331,15 @@
};
}
+ function _maybeDrain(data) {
+ if (data.length === 0 && q.idle()) {
+ // call drain immediately if there are no tasks
+ setImmediate$1(() => trigger('drain'));
+ return true
+ }
+ return false
+ }
+
const eventMethod = (name) => (handler) => {
if (!handler) {
return new Promise((resolve, reject) => {
@@ -1354,13 +1367,17 @@
paused: false,
push (data, callback) {
if (Array.isArray(data)) {
- if (data.length === 0 && q.idle()) {
- // call drain immediately if there are no tasks
- return setImmediate$1(() => trigger('drain'));
- }
- return data.map(datum => _insert(datum, false, callback))
+ if (_maybeDrain(data)) return
+ return data.map(datum => _insert(datum, false, false, callback))
}
- return _insert(data, false, callback);
+ return _insert(data, false, false, callback);
+ },
+ pushAsync (data, callback) {
+ if (Array.isArray(data)) {
+ if (_maybeDrain(data)) return
+ return data.map(datum => _insert(datum, false, true, callback))
+ }
+ return _insert(data, false, true, callback);
},
kill () {
off();
@@ -1368,13 +1385,17 @@
},
unshift (data, callback) {
if (Array.isArray(data)) {
- if (data.length === 0 && q.idle()) {
- // call drain immediately if there are no tasks
- return setImmediate$1(() => trigger('drain'));
- }
- return data.map(datum => _insert(datum, true, callback))
+ if (_maybeDrain(data)) return
+ return data.map(datum => _insert(datum, true, false, callback))
}
- return _insert(data, true, callback);
+ return _insert(data, true, false, callback);
+ },
+ unshiftAsync (data, callback) {
+ if (Array.isArray(data)) {
+ if (_maybeDrain(data)) return
+ return data.map(datum => _insert(datum, true, true, callback))
+ }
+ return _insert(data, true, true, callback);
},
remove (testFn) {
q._tasks.remove(testFn);
@@ -3057,12 +3078,16 @@
* @property {number} payload - an integer that specifies how many items are
* passed to the worker function at a time. only applies if this is a
* [cargo]{@link module:ControlFlow.cargo} object
- * @property {Function} push - add a new task to the `queue`. Calls `callback`
+ * @property {AsyncFunction} push - add a new task to the `queue`. Calls `callback`
* once the `worker` has finished processing the task. Instead of a single task,
* a `tasks` array can be submitted. The respective callback is used for every
* task in the list. Invoke with `queue.push(task, [callback])`,
- * @property {Function} unshift - add a new task to the front of the `queue`.
+ * @property {AsyncFunction} unshift - add a new task to the front of the `queue`.
* Invoke with `queue.unshift(task, [callback])`.
+ * @property {AsyncFunction} pushAsync - the same as `q.push`, except this returns
+ * a promise that rejects if an error occurs.
+ * @property {AsyncFunction} unshirtAsync - the same as `q.unshift`, except this returns
+ * a promise that rejects if an error occurs.
* @property {Function} remove - remove items from the queue that match a test
* function. The test function will be passed an object with a `data` property,
* and a `priority` property, if this is a
@@ -4469,14 +4494,14 @@
*
* @example
* const results = []
- * async.until(function iter(next) {
+ * async.until(function test(page, cb) {
+ * cb(null, page.next == null)
+ * }, function iter(next) {
* fetchPage(url, (err, body) => {
* if (err) return next(err)
* results = results.concat(body.objects)
* next(err, body)
* })
- * }, function test(page, cb) {
- * cb(null, page.next == null)
* }, function done (err) {
* // all pages have been fetched
* })
diff --git a/docs/v3/seq.js.html b/docs/v3/seq.js.html
index 7695317..b333416 100644
--- a/docs/v3/seq.js.html
+++ b/docs/v3/seq.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -147,7 +147,7 @@ export default function seq(...functions) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/series.js.html b/docs/v3/series.js.html
index ed286ef..4d38691 100644
--- a/docs/v3/series.js.html
+++ b/docs/v3/series.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -154,7 +154,7 @@ export default function series(tasks, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/setImmediate.js.html b/docs/v3/setImmediate.js.html
index 9cd67cb..c91ece6 100644
--- a/docs/v3/setImmediate.js.html
+++ b/docs/v3/setImmediate.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -117,7 +117,7 @@ export default setImmediate;
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/some.js.html b/docs/v3/some.js.html
index 81e5d6e..1f1b196 100644
--- a/docs/v3/some.js.html
+++ b/docs/v3/some.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -122,7 +122,7 @@ export default awaitify(some, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/someLimit.js.html b/docs/v3/someLimit.js.html
index 1fc3d49..36123ee 100644
--- a/docs/v3/someLimit.js.html
+++ b/docs/v3/someLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -113,7 +113,7 @@ export default awaitify(someLimit, 4);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/someSeries.js.html b/docs/v3/someSeries.js.html
index b6333f5..e87c491 100644
--- a/docs/v3/someSeries.js.html
+++ b/docs/v3/someSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -112,7 +112,7 @@ export default awaitify(someSeries, 3);
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/sortBy.js.html b/docs/v3/sortBy.js.html
index 555c01b..0fd35f6 100644
--- a/docs/v3/sortBy.js.html
+++ b/docs/v3/sortBy.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -153,7 +153,7 @@ export default awaitify(sortBy, 3)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/timeout.js.html b/docs/v3/timeout.js.html
index c18e0a2..48e8597 100644
--- a/docs/v3/timeout.js.html
+++ b/docs/v3/timeout.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -157,7 +157,7 @@ export default function timeout(asyncFn, milliseconds, info) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/times.js.html b/docs/v3/times.js.html
index c667d80..ae6c4ac 100644
--- a/docs/v3/times.js.html
+++ b/docs/v3/times.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -121,7 +121,7 @@ export default function times (n, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/timesLimit.js.html b/docs/v3/timesLimit.js.html
index 4ab056f..c4b9194 100644
--- a/docs/v3/timesLimit.js.html
+++ b/docs/v3/timesLimit.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -108,7 +108,7 @@ export default function timesLimit(count, limit, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/timesSeries.js.html b/docs/v3/timesSeries.js.html
index ae42d0d..8354bfd 100644
--- a/docs/v3/timesSeries.js.html
+++ b/docs/v3/timesSeries.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -103,7 +103,7 @@ export default function timesSeries (n, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/transform.js.html b/docs/v3/transform.js.html
index ba5d731..585870f 100644
--- a/docs/v3/transform.js.html
+++ b/docs/v3/transform.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -145,7 +145,7 @@ export default function transform (coll, accumulator, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/tryEach.js.html b/docs/v3/tryEach.js.html
index d5fc700..4fec494 100644
--- a/docs/v3/tryEach.js.html
+++ b/docs/v3/tryEach.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -144,7 +144,7 @@ export default awaitify(tryEach)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/unmemoize.js.html b/docs/v3/unmemoize.js.html
index 6105132..9d62f68 100644
--- a/docs/v3/unmemoize.js.html
+++ b/docs/v3/unmemoize.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -101,7 +101,7 @@ export default function unmemoize(fn) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/until.js.html b/docs/v3/until.js.html
index c352377..d7559fa 100644
--- a/docs/v3/until.js.html
+++ b/docs/v3/until.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -127,7 +127,7 @@ export default function until(test, iteratee, callback) {
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/waterfall.js.html b/docs/v3/waterfall.js.html
index e3bd293..965e7b8 100644
--- a/docs/v3/waterfall.js.html
+++ b/docs/v3/waterfall.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -169,7 +169,7 @@ export default awaitify(waterfall)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>
diff --git a/docs/v3/whilst.js.html b/docs/v3/whilst.js.html
index 74599a6..ab1c531 100644
--- a/docs/v3/whilst.js.html
+++ b/docs/v3/whilst.js.html
@@ -30,7 +30,7 @@
</div>
<ul class="nav navbar-nav">
<li id="version-dropdown" class="dropdown">
- <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.0.1 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.1.1 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -144,7 +144,7 @@ export default awaitify(whilst, 3)
<footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the Minami theme.
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a> using the Minami theme.
</footer></div>
</div>