summaryrefslogtreecommitdiff
path: root/docs/v3/queue.js.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/v3/queue.js.html')
-rw-r--r--docs/v3/queue.js.html12
1 files changed, 8 insertions, 4 deletions
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>