summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHubert Argasinski <argasinski.hubert@gmail.com>2017-05-24 21:53:09 -0400
committerHubert Argasinski <argasinski.hubert@gmail.com>2017-05-24 21:53:09 -0400
commita024630253b3ab10d9612e6cebbb98338d7af1f1 (patch)
treee2370da89078ac5e32867df80d79a23fa951f2c4
parent3cb7c15300a5b43b7404004bb502fe9c630bb855 (diff)
downloadasync-a024630253b3ab10d9612e6cebbb98338d7af1f1.tar.gz
clarify q.kill docs [fixes #1422]
-rw-r--r--lib/queue.js3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/queue.js b/lib/queue.js
index 2d0abb7..2ba1747 100644
--- a/lib/queue.js
+++ b/lib/queue.js
@@ -51,7 +51,8 @@ import wrapAsync from './internal/wrapAsync';
* @property {Function} resume - a function that resumes the processing of
* queued tasks when the queue is paused. Invoke with `queue.resume()`.
* @property {Function} kill - a function that removes the `drain` callback and
- * empties remaining tasks from the queue forcing it to go idle. Invoke with `queue.kill()`.
+ * empties remaining tasks from the queue forcing it to go idle. No more tasks
+ * should be pushed to the queue after calling this function. Invoke with `queue.kill()`.
*/
/**