summaryrefslogtreecommitdiff
path: root/lib/groupByLimit.js
diff options
context:
space:
mode:
authorAlexander Early <alexander.early@gmail.com>2017-04-01 15:05:52 -0700
committerAlexander Early <alexander.early@gmail.com>2017-04-01 15:05:52 -0700
commit94a8b2d18bf10cca67cf4c308253f642bbb2b160 (patch)
tree001afe9b92618fe3ce75e7bdd0979e59ee0a8d63 /lib/groupByLimit.js
parentfaf395c546747c2066e673405e0aec94362811a0 (diff)
downloadasync-94a8b2d18bf10cca67cf4c308253f642bbb2b160.tar.gz
use the AsyncFunction type in all docs :sweat:
Diffstat (limited to 'lib/groupByLimit.js')
-rw-r--r--lib/groupByLimit.js8
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/groupByLimit.js b/lib/groupByLimit.js
index c148351..b0a5ef3 100644
--- a/lib/groupByLimit.js
+++ b/lib/groupByLimit.js
@@ -12,10 +12,10 @@ 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, key)` which must be called once it
- * has completed with an error (which can be `null`) and the `key` to group the
- * value under. Invoked with (value, callback).
+ * @param {AsyncFunction} iteratee - An async function to apply to each item in
+ * `coll`.
+ * The iteratee should complete with a `key` to group the value under.
+ * Invoked with (value, callback).
* @param {Function} [callback] - A callback which is called when all `iteratee`
* functions have finished, or an error occurs. Result is an `Object` whoses
* properties are arrays of values which returned the corresponding key.