diff options
Diffstat (limited to 'lib/priorityQueue.js')
| -rw-r--r-- | lib/priorityQueue.js | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/priorityQueue.js b/lib/priorityQueue.js index 36cacaf..9ea24bc 100644 --- a/lib/priorityQueue.js +++ b/lib/priorityQueue.js @@ -7,13 +7,14 @@ import setImmediate from './setImmediate'; import queue from './queue'; /** - * The same as {@link async.queue} only tasks are assigned a priority and + * The same as [async.queue]{@link module:ControlFlow.queue} only tasks are assigned a priority and * completed in ascending priority order. * * @name priorityQueue * @static - * @memberOf async - * @see async.queue + * @memberOf module:ControlFlow + * @method + * @see [async.queue]{@link module:ControlFlow.queue} * @category Control Flow * @param {Function} worker - An asynchronous function for processing a queued * task, which must call its `callback(err)` argument when finished, with an @@ -23,7 +24,7 @@ import queue from './queue'; * @param {number} concurrency - 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 {queue} A priorityQueue object to manage the tasks. There are two + * @returns {module:ControlFlow.QueueObject} A priorityQueue object to manage the tasks. There are two * differences between `queue` and `priorityQueue` objects: * * `push(task, priority, [callback])` - `priority` should be a number. If an * array of `tasks` is given, all tasks will be assigned the same priority. |