diff options
Diffstat (limited to 'lib/eachLimit.js')
-rw-r--r-- | lib/eachLimit.js | 11 |
1 files changed, 5 insertions, 6 deletions
diff --git a/lib/eachLimit.js b/lib/eachLimit.js index c3bc595..462e329 100644 --- a/lib/eachLimit.js +++ b/lib/eachLimit.js @@ -14,12 +14,11 @@ import wrapAsync from './internal/wrapAsync'; * @category Collection * @param {Array|Iterable|Object} coll - A collection to iterate over. * @param {number} limit - The maximum number of async operations at a time. - * @param {Function} iteratee - A function to apply to each item in `coll`. The - * iteratee is passed a `callback(err)` which must be called once it has - * completed. If no error has occurred, the `callback` should be run without - * arguments or with an explicit `null` argument. The array index is not passed - * to the iteratee. Invoked with (item, callback). If you need the index, use - * `eachOfLimit`. + * @param {AsyncFunction} iteratee - An async function to apply to each item in + * `coll`. + * The array index is not passed to the iteratee. + * If you need the index, use `eachOfLimit`. + * Invoked with (item, callback). * @param {Function} [callback] - A callback which is called when all * `iteratee` functions have finished, or an error occurs. Invoked with (err). */ |