summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Early <alexander.early@gmail.com>2017-04-02 13:49:47 -0700
committerAlexander Early <alexander.early@gmail.com>2017-04-02 13:49:47 -0700
commit8faed87d71496776c7100dc29f2a8e294261c820 (patch)
treed01a28c5b8f6911c48cb98982157df063744a926
parentfab1e45a4a61659049eb43460a1b6183d7429c4d (diff)
downloadasync-fn-support.tar.gz
missed some docsasync-fn-support
-rw-r--r--lib/some.js8
-rw-r--r--lib/waterfall.js8
2 files changed, 8 insertions, 8 deletions
diff --git a/lib/some.js b/lib/some.js
index 3cb77e8..ce91ce8 100644
--- a/lib/some.js
+++ b/lib/some.js
@@ -14,10 +14,10 @@ import identity from 'lodash/identity';
* @alias any
* @category Collection
* @param {Array|Iterable|Object} coll - A collection to iterate over.
- * @param {Function} iteratee - A truth test to apply to each item in the array
- * in parallel. 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 {AsyncFunction} iteratee - An async truth test to apply to each item
+ * in the collections in parallel.
+ * The iteratee should complete with a boolean `result` value.
+ * Invoked with (item, callback).
* @param {Function} [callback] - A callback which is called as soon as any
* iteratee returns `true`, or after all the iteratee functions have finished.
* Result will be either `true` or `false` depending on the values of the async
diff --git a/lib/waterfall.js b/lib/waterfall.js
index cb2c1fd..24befac 100644
--- a/lib/waterfall.js
+++ b/lib/waterfall.js
@@ -17,10 +17,10 @@ import wrapAsync from './internal/wrapAsync';
* @memberOf module:ControlFlow
* @method
* @category Control Flow
- * @param {Array} tasks - An array of functions to run, each function is passed
- * a `callback(err, result1, result2, ...)` it must call on completion. The
- * first argument is an error (which can be `null`) and any further arguments
- * will be passed as arguments in order to the next task.
+ * @param {Array} tasks - An array of [async functions]{@link AsyncFunction}
+ * to run.
+ * Each function should complete with any number of `result` values.
+ * The `result` values will be passed as arguments, in order, to the next task.
* @param {Function} [callback] - An optional callback to run once all the
* functions have completed. This will be passed the results of the last task's
* callback. Invoked with (err, [results]).