Merge pull request #1236 from caolan/iterable-docs

Iterable docs

lib/applyEach.js

@@ -12,7 +12,7 @@ import map from './map';
  * @memberOf module:ControlFlow
  * @method
  * @category Control Flow
- * @param {Array|Object} fns - A collection of asynchronous functions to all
+ * @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.

lib/applyEachSeries.js

@@ -10,7 +10,7 @@ import mapSeries from './mapSeries';
  * @method
  * @see [async.applyEach]{@link module:ControlFlow.applyEach}
  * @category Control Flow
- * @param {Array|Object} fns - A collection of asynchronous functions to all
+ * @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.

lib/concat.js

@@ -13,7 +13,7 @@ import doParallel from './internal/doParallel';
  * @memberOf module:Collections
  * @method
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A function to apply to each item in `coll`.
  * The iteratee is passed a `callback(err, results)` which must be called once
  * it has completed with an error (which can be `null`) and an array of results.

lib/concatSeries.js

@@ -10,7 +10,7 @@ import doSeries from './internal/doSeries';
  * @method
  * @see [async.concat]{@link module:Collections.concat}
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A function to apply to each item in `coll`.
  * The iteratee is passed a `callback(err, results)` which must be called once
  * it has completed with an error (which can be `null`) and an array of results.

lib/detect.js

@@ -20,7 +20,7 @@ import findGetResult from './internal/findGetResult';
  * @method
  * @alias find
  * @category Collections
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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).

lib/detectLimit.js

@@ -15,7 +15,7 @@ import findGetResult from './internal/findGetResult';
  * @see [async.detect]{@link module:Collections.detect}
  * @alias findLimit
  * @category Collections
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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 truth test to apply to each item in `coll`.
  * The iteratee is passed a `callback(err, truthValue)` which must be called

lib/detectSeries.js

@@ -14,7 +14,7 @@ import findGetResult from './internal/findGetResult';
  * @see [async.detect]{@link module:Collections.detect}
  * @alias findSeries
  * @category Collections
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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).

lib/each.js

@@ -17,7 +17,7 @@ import doLimit from './internal/doLimit';
  * @method
  * @alias forEach
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A function to apply to each item
  * in `coll`. The iteratee is passed a `callback(err)` which must be called once
  * it has completed. If no error has occurred, the `callback` should be run

lib/eachLimit.js

@@ -11,7 +11,7 @@ import withoutIndex from './internal/withoutIndex';
  * @see [async.each]{@link module:Collections.each}
  * @alias forEachLimit
  * @category Collection
- * @param {Array|Object} coll - A colleciton to iterate over.
+ * @param {Array|Iterable|Object} coll - A colleciton 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)` which must be called once it has

lib/eachOf.js

@@ -12,7 +12,7 @@ import doLimit from './internal/doLimit';
  * @alias forEachOf
  * @category Collection
  * @see [async.each]{@link module:Collections.each}
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A function to apply to each
  * item in `coll`. The `key` is the item's key, or index in the case of an
  * array. The iteratee is passed a `callback(err)` which must be called once it

lib/eachOfLimit.js

@@ -11,7 +11,7 @@ import _eachOfLimit from './internal/eachOfLimit';
  * @see [async.eachOf]{@link module:Collections.eachOf}
  * @alias forEachOfLimit
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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 `key` is the item's key, or index in the case of an

lib/eachOfSeries.js

@@ -11,7 +11,7 @@ import doLimit from './internal/doLimit';
  * @see [async.eachOf]{@link module:Collections.eachOf}
  * @alias forEachOfSeries
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A function to apply to each item in `coll`. The
  * `key` is the item's key, or index in the case of an array. The iteratee is
  * passed a `callback(err)` which must be called once it has completed. If no

lib/eachSeries.js

@@ -11,7 +11,7 @@ import doLimit from './internal/doLimit';
  * @see [async.each]{@link module:Collections.each}
  * @alias forEachSeries
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A function to apply to each
  * item in `coll`. The iteratee is passed a `callback(err)` which must be called
  * once it has completed. If no error has occurred, the `callback` should be run

lib/every.js

@@ -11,7 +11,7 @@ import doLimit from './internal/doLimit';
  * @method
  * @alias all
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A truth test to apply to each item in the
  * collection in parallel. The iteratee is passed a `callback(err, truthValue)`
  * which must be called with a  boolean argument once it has completed. Invoked

lib/everyLimit.js

@@ -12,7 +12,7 @@ import notId from './internal/notId';
  * @see [async.every]{@link module:Collections.every}
  * @alias allLimit
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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 truth test to apply to each item in the
  * collection in parallel. The iteratee is passed a `callback(err, truthValue)`

lib/everySeries.js

@@ -11,7 +11,7 @@ import doLimit from './internal/doLimit';
  * @see [async.every]{@link module:Collections.every}
  * @alias allSeries
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A truth test to apply to each item in the
  * collection in parallel. The iteratee is passed a `callback(err, truthValue)`
  * which must be called with a  boolean argument once it has completed. Invoked

lib/filter.js

@@ -12,7 +12,7 @@ import doLimit from './internal/doLimit';
  * @method
  * @alias select
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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).

lib/filterLimit.js

@@ -12,7 +12,7 @@ import doParallelLimit from './internal/doParallelLimit';
  * @see [async.filter]{@link module:Collections.filter}
  * @alias selectLimit
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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 truth test to apply to each item in `coll`.
  * The `iteratee` is passed a `callback(err, truthValue)`, which must be called

lib/filterSeries.js

@@ -11,7 +11,7 @@ import doLimit from './internal/doLimit';
  * @see [async.filter]{@link module:Collections.filter}
  * @alias selectSeries
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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).

lib/map.js

@@ -23,7 +23,7 @@ import doLimit from './internal/doLimit';
  * @memberOf module:Collections
  * @method
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A function to apply to each item in `coll`.
  * The iteratee is passed a `callback(err, transformed)` which must be called
  * once it has completed with an error (which can be `null`) and a

lib/mapLimit.js

@@ -10,7 +10,7 @@ import map from './internal/map';
  * @method
  * @see [async.map]{@link module:Collections.map}
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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, transformed)` which must be called

lib/mapSeries.js

@@ -10,7 +10,7 @@ import doLimit from './internal/doLimit';
  * @method
  * @see [async.map]{@link module:Collections.map}
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A function to apply to each item in `coll`.
  * The iteratee is passed a `callback(err, transformed)` which must be called
  * once it has completed with an error (which can be `null`) and a

lib/parallel.js

@@ -24,7 +24,7 @@ import doLimit from './internal/doLimit';
  * @memberOf module:ControlFlow
  * @method
  * @category Control Flow
- * @param {Array|Object} tasks - A collection containing functions to run.
+ * @param {Array|Iterable|Object} tasks - A collection containing functions to run.
  * Each function is passed a `callback(err, result)` which it must call on
  * completion with an error `err` (which can be `null`) and an optional `result`
  * value.

lib/reduce.js

@@ -20,7 +20,7 @@ import once from './internal/once';
  * @alias inject
  * @alias foldl
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {*} memo - The initial state of the reduction.
  * @param {Function} iteratee - A function applied to each item in the
  * array to produce the next step in the reduction. The `iteratee` is passed a

lib/reduceRight.js

@@ -3,7 +3,7 @@ import reduce from './reduce';
 var slice = Array.prototype.slice;
 
 /**
- * Same as [`reduce`]{@link module:Collections.reduce}, only operates on `coll` in reverse order.
+ * Same as [`reduce`]{@link module:Collections.reduce}, only operates on `array` in reverse order.
  *
  * @name reduceRight
  * @static
@@ -12,7 +12,7 @@ var slice = Array.prototype.slice;
  * @see [async.reduce]{@link module:Collections.reduce}
  * @alias foldr
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array} array - A collection to iterate over.
  * @param {*} memo - The initial state of the reduction.
  * @param {Function} iteratee - A function applied to each item in the
  * array to produce the next step in the reduction. The `iteratee` is passed a
@@ -24,7 +24,7 @@ var slice = Array.prototype.slice;
  * `iteratee` functions have finished. Result is the reduced value. Invoked with
  * (err, result).
  */
-export default function reduceRight (coll, memo, iteratee, callback) {
-    var reversed = slice.call(coll).reverse();
+export default function reduceRight (array, memo, iteratee, callback) {
+    var reversed = slice.call(array).reverse();
     reduce(reversed, memo, iteratee, callback);
 }

lib/reject.js

@@ -10,7 +10,7 @@ import doLimit from './internal/doLimit';
  * @method
  * @see [async.filter]{@link module:Collections.filter}
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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).

lib/rejectLimit.js

@@ -11,7 +11,7 @@ import doParallelLimit from './internal/doParallelLimit';
  * @method
  * @see [async.reject]{@link module:Collections.reject}
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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 truth test to apply to each item in `coll`.
  * The `iteratee` is passed a `callback(err, truthValue)`, which must be called

lib/rejectSeries.js

@@ -10,7 +10,7 @@ import doLimit from './internal/doLimit';
  * @method
  * @see [async.reject]{@link module:Collections.reject}
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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).

lib/series.js

@@ -27,7 +27,7 @@ import eachOfSeries from './eachOfSeries';
  * @memberOf module:ControlFlow
  * @method
  * @category Control Flow
- * @param {Array|Object} tasks - A collection containing functions to run, each
+ * @param {Array|Iterable|Object} tasks - A collection containing functions to run, each
  * function is passed a `callback(err, result)` it must call on completion with
  * an error `err` (which can be `null`) and an optional `result` value.
  * @param {Function} [callback] - An optional callback to run once all the

lib/some.js

@@ -12,7 +12,7 @@ import doLimit from './internal/doLimit';
  * @method
  * @alias any
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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

lib/someLimit.js

@@ -12,7 +12,7 @@ import identity from 'lodash/identity';
  * @see [async.some]{@link module:Collections.some}
  * @alias anyLimit
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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 truth test to apply to each item in the array
  * in parallel. The iteratee is passed a `callback(err, truthValue)` which must

lib/someSeries.js

@@ -11,7 +11,7 @@ import doLimit from './internal/doLimit';
  * @see [async.some]{@link module:Collections.some}
  * @alias anySeries
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @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

lib/sortBy.js

@@ -12,7 +12,7 @@ import map from './map';
  * @memberOf module:Collections
  * @method
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {Function} iteratee - A function to apply to each item in `coll`.
  * The iteratee is passed a `callback(err, sortValue)` which must be called once
  * it has completed with an error (which can be `null`) and a value to use as

lib/transform.js

@@ -14,7 +14,7 @@ import once from './internal/once';
  * @memberOf module:Collections
  * @method
  * @category Collection
- * @param {Array|Object} coll - A collection to iterate over.
+ * @param {Array|Iterable|Object} coll - A collection to iterate over.
  * @param {*} [accumulator] - The initial state of the transform.  If omitted,
  * it will default to an empty Object or Array, depending on the type of `coll`
  * @param {Function} iteratee - A function applied to each item in the