summaryrefslogtreecommitdiff
path: root/docs/v3/module-ControlFlow.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/v3/module-ControlFlow.html')
-rw-r--r--docs/v3/module-ControlFlow.html42
1 files changed, 34 insertions, 8 deletions
diff --git a/docs/v3/module-ControlFlow.html b/docs/v3/module-ControlFlow.html
index 8ca7162..b14ee1b 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.2.3 <span class="caret"></span>
+ <a href="#" class="dropdown-toggle vertically-centered" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v3.2.4 <span class="caret"></span>
</a>
<ul class="dropdown-menu">
<li><a href="../v3/">v3.0.x</a></li>
@@ -3270,12 +3270,14 @@ functions should be run in parallel. If omitted, the concurrency defaults to
<div class="param-desc">
- <p>A priorityQueue object to manage the tasks. There are two
+ <p>A priorityQueue object to manage the tasks. There are three
differences between <code>queue</code> and <code>priorityQueue</code> objects:</p>
<ul>
<li><code>push(task, priority, [callback])</code> - <code>priority</code> should be a number. If an
array of <code>tasks</code> is given, all tasks will be assigned the same priority.</li>
-<li>The <code>unshift</code> method was removed.</li>
+<li><code>pushAsync(task, priority, [callback])</code> - the same as <code>priorityQueue.push</code>,
+except this returns a promise that rejects if an error occurs.</li>
+<li>The <code>unshift</code> and <code>unshiftAsync</code> methods were removed.</li>
</ul>
</div>
@@ -3329,7 +3331,7 @@ array of <code>tasks</code> is given, all tasks will be assigned the same priori
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
- <a href="priorityQueue.js.html">priorityQueue.js</a>, <a href="priorityQueue.js.html#line5">line 5</a>
+ <a href="priorityQueue.js.html">priorityQueue.js</a>, <a href="priorityQueue.js.html#line4">line 4</a>
</li></ul></dd>
@@ -3603,7 +3605,7 @@ q.unshift({name: &apos;bar&apos;}, function (err) {
- <h4 class="name" id="race"><span class="type-signature">(static) </span>race<span class="signature">(tasks, callback)</span><span class="type-signature"></span></h4>
+ <h4 class="name" id="race"><span class="type-signature">(static) </span>race<span class="signature">(tasks, callback)</span><span class="type-signature"> &#x2192; {Promise}</span></h4>
@@ -3708,11 +3710,23 @@ completed. Invoked with (err, result).</p></td>
<div class="param-desc">
- <p>undefined</p>
+ <p>a promise, if a callback is omitted</p>
</div>
+<dl class="param-type">
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type">Promise</span>
+
+
+ </dd>
+</dl>
+
@@ -5983,7 +5997,7 @@ async.until(function test(cb) {
- <h4 class="name" id="waterfall"><span class="type-signature">(static) </span>waterfall<span class="signature">(tasks, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+ <h4 class="name" id="waterfall"><span class="type-signature">(static) </span>waterfall<span class="signature">(tasks, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &#x2192; {Promise}</span></h4>
@@ -6092,11 +6106,23 @@ callback. Invoked with (err, [results]).</p></td>
<div class="param-desc">
- <p>undefined</p>
+ <p>a promise, if a callback is omitted</p>
</div>
+<dl class="param-type">
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+<span class="param-type">Promise</span>
+
+
+ </dd>
+</dl>
+