Skip to content

Commit

Permalink
clarified applyEach arguments, fixes #1278
Browse files Browse the repository at this point in the history
  • Loading branch information
hargasinski committed Sep 6, 2016
1 parent f15420b commit f49d94f
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions lib/applyEach.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,25 @@ import map from './map';
/**
* Applies the provided arguments to each function in the array, calling
* `callback` after all functions have completed. If you only provide the first
* argument, then it will return a function which lets you pass in the
* arguments as if it were a single function call.
* argument, `fns`, then it will return a function which lets you pass in the
* arguments as if it were a single function call. If more arguments are
* provided, `callback` is required while `args` is still optional.
*
* @name applyEach
* @static
* @memberOf module:ControlFlow
* @method
* @category Control Flow
* @param {Array|Iterable|Object} fns - A collection of asynchronous functions to all
* call with the same arguments
* @param {Array|Iterable|Object} fns - A collection of asynchronous functions
* to all call with the same arguments
* @param {...*} [args] - any number of separate arguments to pass to the
* function.
* @param {Function} [callback] - the final argument should be the callback,
* called when all functions have completed processing.
* @returns {Function} - If only the first argument is provided, it will return
* a function which lets you pass in the arguments as if it were a single
* function call.
* @returns {Function} - If only the first argument, `fns`, is provided, it will
* return a function which lets you pass in the arguments as if it were a single
* function call. The signature is `(..args, callback)`. If invoked with any
* arguments, `callback` is required.
* @example
*
* async.applyEach([enableSearch, updateSchema], 'bucket', callback);
Expand Down

0 comments on commit f49d94f

Please sign in to comment.