summaryrefslogtreecommitdiff
path: root/lib/reject.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/reject.js
parentfaf395c546747c2066e673405e0aec94362811a0 (diff)
downloadasync-94a8b2d18bf10cca67cf4c308253f642bbb2b160.tar.gz
use the AsyncFunction type in all docs :sweat:
Diffstat (limited to 'lib/reject.js')
-rw-r--r--lib/reject.js7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/reject.js b/lib/reject.js
index 0ddbaf0..95a6270 100644
--- a/lib/reject.js
+++ b/lib/reject.js
@@ -11,9 +11,10 @@ import doParallel from './internal/doParallel';
* @see [async.filter]{@link module:Collections.filter}
* @category Collection
* @param {Array|Iterable|Object} coll - A collection to iterate over.
- * @param {Function} iteratee - A truth test to apply to each item in `coll`.
- * The `iteratee` is passed a `callback(err, truthValue)`, which must be called
- * with a boolean argument once it has completed. Invoked with (item, callback).
+ * @param {Function} iteratee - An async truth test to apply to each item in
+ * `coll`.
+ * The should complete with a boolean value as its `result`.
+ * Invoked with (item, callback).
* @param {Function} [callback] - A callback which is called after all the
* `iteratee` functions have finished. Invoked with (err, results).
* @example