diff options
author | Alexander Early <alexander.early@gmail.com> | 2017-04-02 13:49:47 -0700 |
---|---|---|
committer | Alexander Early <alexander.early@gmail.com> | 2017-04-02 13:49:47 -0700 |
commit | 8faed87d71496776c7100dc29f2a8e294261c820 (patch) | |
tree | d01a28c5b8f6911c48cb98982157df063744a926 /lib/waterfall.js | |
parent | fab1e45a4a61659049eb43460a1b6183d7429c4d (diff) | |
download | async-fn-support.tar.gz |
missed some docsasync-fn-support
Diffstat (limited to 'lib/waterfall.js')
-rw-r--r-- | lib/waterfall.js | 8 |
1 files changed, 4 insertions, 4 deletions
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]). |