summaryrefslogtreecommitdiff
path: root/lib/eachOfSeries.js
diff options
context:
space:
mode:
Diffstat (limited to 'lib/eachOfSeries.js')
-rw-r--r--lib/eachOfSeries.js18
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/eachOfSeries.js b/lib/eachOfSeries.js
index 47787bb..0718805 100644
--- a/lib/eachOfSeries.js
+++ b/lib/eachOfSeries.js
@@ -3,4 +3,22 @@
import eachOfLimit from './eachOfLimit';
import doLimit from './internal/doLimit';
+/**
+ * The same as `eachOf` but runs only a single async operation at a time.
+ *
+ * @name eachOfSeries
+ * @static
+ * @memberOf async
+ * @see async.eachOf
+ * @alias forEachOfSeries
+ * @category Collection
+ * @param {Array|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
+ * error has occurred, the callback should be run without arguments or with an
+ * explicit `null` argument. Invoked with (item, key, callback).
+ * @param {Function} [callback] - A callback which is called when all `iteratee`
+ * functions have finished, or an error occurs. Invoked with (err).
+ */
export default doLimit(eachOfLimit, 1);