summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohan Nordberg <its@johan-nordberg.com>2016-05-31 22:59:03 +0200
committerJohan Nordberg <its@johan-nordberg.com>2016-05-31 22:59:03 +0200
commit6c3a2ef2848908d03042ef0446165568a7113fa0 (patch)
tree3a8d0a9fc9a79969ba5cec450b031056ae5ddb26
parent6037f03e2a6ce9f6b8f02eb4842c37cf0a10b34d (diff)
downloadasync-6c3a2ef2848908d03042ef0446165568a7113fa0.tar.gz
Document queue error callback
-rw-r--r--lib/queue.js2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/queue.js b/lib/queue.js
index 683f227..936ccd9 100644
--- a/lib/queue.js
+++ b/lib/queue.js
@@ -36,6 +36,8 @@ import queue from './internal/queue';
* from the `queue` is given to a `worker`.
* @property {Function} drain - a callback that is called when the last item
* from the `queue` has returned from the `worker`.
+ * @property {Function} error - a callback that is called when a task errors.
+ * Has the signature `function(error, task)`.
* @property {boolean} paused - a boolean for determining whether the queue is
* in a paused state.
* @property {Function} pause - a function that pauses the processing of tasks