summaryrefslogtreecommitdiff
path: root/lib/rejectSeries.js
diff options
context:
space:
mode:
Diffstat (limited to 'lib/rejectSeries.js')
-rw-r--r--lib/rejectSeries.js15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/rejectSeries.js b/lib/rejectSeries.js
index 00c145f..1732eca 100644
--- a/lib/rejectSeries.js
+++ b/lib/rejectSeries.js
@@ -3,4 +3,19 @@
import rejectLimit from './rejectLimit';
import doLimit from './internal/doLimit';
+/**
+ * The same as `reject` but runs only a single async operation at a time.
+ *
+ * @name rejectSeries
+ * @static
+ * @memberOf async
+ * @see async.reject
+ * @category Collection
+ * @param {Array|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).
+ * @param {Function} [callback] - A callback which is called after all the
+ * `iteratee` functions have finished. Invoked with (err, results).
+ */
export default doLimit(rejectLimit, 1);