summaryrefslogtreecommitdiff
path: root/lib
diff options
context:
space:
mode:
authorAlex Early <alexander.early@gmail.com>2017-04-06 22:46:22 -0700
committerGitHub <noreply@github.com>2017-04-06 22:46:22 -0700
commit7aa90f39cf8ed4e92a9c939f0521ce1482312c67 (patch)
treef4084b132306af7702050ebbeaadc0fff47b2b90 /lib
parentb3679d50bee2a98c7b399ed7cbb6cc0081c578e5 (diff)
parent465cfe8c919d949e12a1c3215d9eb616cdccc910 (diff)
downloadasync-7aa90f39cf8ed4e92a9c939f0521ce1482312c67.tar.gz
Merge pull request #1365 from alFReD-NSH/try
Add async.tryEach
Diffstat (limited to 'lib')
-rw-r--r--lib/index.js3
-rw-r--r--lib/tryEach.js58
2 files changed, 61 insertions, 0 deletions
diff --git a/lib/index.js b/lib/index.js
index f1e8e98..0e2e457 100644
--- a/lib/index.js
+++ b/lib/index.js
@@ -134,6 +134,7 @@ import times from './times';
import timesLimit from './timesLimit';
import timesSeries from './timesSeries';
import transform from './transform';
+import tryEach from './tryEach';
import unmemoize from './unmemoize';
import until from './until';
import waterfall from './waterfall';
@@ -211,6 +212,7 @@ export default {
timesLimit: timesLimit,
timesSeries: timesSeries,
transform: transform,
+ tryEach: tryEach,
unmemoize: unmemoize,
until: until,
waterfall: waterfall,
@@ -306,6 +308,7 @@ export {
timesLimit as timesLimit,
timesSeries as timesSeries,
transform as transform,
+ tryEach as tryEach,
unmemoize as unmemoize,
until as until,
waterfall as waterfall,
diff --git a/lib/tryEach.js b/lib/tryEach.js
new file mode 100644
index 0000000..d87245f
--- /dev/null
+++ b/lib/tryEach.js
@@ -0,0 +1,58 @@
+import noop from 'lodash/noop';
+import eachSeries from './eachSeries';
+import rest from './internal/rest';
+
+/**
+ * It runs each task in series but stops whenever any of the functions were
+ * successful. If one of the tasks were successful, the `callback` will be
+ * passed the result of the successful task. If all tasks fail, the callback
+ * will be passed the error and result (if any) of the final attempt.
+ *
+ * @name tryEach
+ * @static
+ * @memberOf module:ControlFlow
+ * @method
+ * @category Control Flow
+ * @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 which is called when one
+ * of the tasks has succeeded, or all have failed. It receives the `err` and
+ * `result` arguments of the last attempt at completing the `task`. Invoked with
+ * (err, results).
+ * @example
+ * async.try([
+ * function getDataFromFirstWebsite(callback) {
+ * // Try getting the data from the first website
+ * callback(err, data);
+ * },
+ * function getDataFromSecondWebsite(callback) {
+ * // First website failed,
+ * // Try getting the data from the backup website
+ * callback(err, data);
+ * }
+ * ],
+ * // optional callback
+ * function(err, results) {
+ * Now do something with the data.
+ * });
+ *
+ */
+export default function tryEach(tasks, callback) {
+ var error = null;
+ var result;
+ callback = callback || noop;
+ eachSeries(tasks, function(task, callback) {
+ task(rest(function (err, args) {
+ if (args.length <= 1) {
+ args = args[0];
+ }
+ error = err;
+ result = args;
+ callback(!err);
+ }));
+ }, function () {
+ callback(error, result);
+ });
+}