diff options
author | Hubert Argasinski <argasinski.hubert@gmail.com> | 2016-06-29 01:35:29 -0400 |
---|---|---|
committer | Hubert Argasinski <argasinski.hubert@gmail.com> | 2016-06-29 01:56:11 -0400 |
commit | 7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da (patch) | |
tree | 942b9ea5e9a18f7f55fd01c51555d0c01f82fc5e /lib/queue.js | |
parent | 90c4f893a30044b67d48a62e42d2c42f379a822f (diff) | |
download | async-7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da.tar.gz |
jsdocs: using proxy modules as categories, modifying minami theme
jsdocs: style fix in outputted html
jsdoc: added documentation to support script
Diffstat (limited to 'lib/queue.js')
-rw-r--r-- | lib/queue.js | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/queue.js b/lib/queue.js index 799cc97..5f032d7 100644 --- a/lib/queue.js +++ b/lib/queue.js @@ -3,7 +3,7 @@ import queue from './internal/queue'; /** * A queue of tasks for the worker function to complete. * @typedef {Object} QueueObject - * @memberOf module:async + * @memberOf module:ControlFlow * @property {Function} length - a function returning the number of items * waiting to be processed. Invoke with `queue.length()`. * @property {Function} started - a function returning whether or not any @@ -48,6 +48,9 @@ import queue from './internal/queue'; */ /** + * ``` + * import queue from 'async/queue' + * ``` * Creates a `queue` object with the specified `concurrency`. Tasks added to the * `queue` are processed in parallel (up to the `concurrency` limit). If all * `worker`s are in progress, the task is queued until one becomes available. @@ -55,7 +58,7 @@ import queue from './internal/queue'; * * @name queue * @static - * @memberOf module:async + * @memberOf module:ControlFlow * @method * @category Control Flow * @param {Function} worker - An asynchronous function for processing a queued @@ -66,7 +69,7 @@ import queue from './internal/queue'; * @param {number} [concurrency=1] - An `integer` for determining how many * `worker` functions should be run in parallel. If omitted, the concurrency * defaults to `1`. If the concurrency is `0`, an error is thrown. - * @returns {module:async.QueueObject} A queue object to manage the tasks. Callbacks can + * @returns {module:ControlFlow.QueueObject} A queue object to manage the tasks. Callbacks can * attached as certain properties to listen for specific events during the * lifecycle of the queue. * @example |