diff options
Diffstat (limited to 'lib/doUntil.js')
-rw-r--r-- | lib/doUntil.js | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/lib/doUntil.js b/lib/doUntil.js index d5f2b83..e5c48c9 100644 --- a/lib/doUntil.js +++ b/lib/doUntil.js @@ -2,6 +2,25 @@ import doWhilst from './doWhilst'; +/** + * Like [`doWhilst`](#doWhilst), except the `test` is inverted. Note the + * argument ordering differs from `until`. + * + * @name doUntil + * @static + * @memberOf async + * @see `async.doWhilst` + * @category Control Flow + * @param {Function} fn - A function which is called each time `test` fails. + * The function is passed a `callback(err)`, which must be called once it has + * completed with an optional `err` argument. Invoked with (callback). + * @param {Function} test - synchronous truth test to perform before each + * execution of `fn`. Invoked with (). + * @param {Function} [callback] - A callback which is called after the test + * function has passed and repeated execution of `fn` has stopped. `callback` + * will be passed an error and any arguments passed to the final `fn`'s + * callback. Invoked with (err, [results]); + */ export default function doUntil(iteratee, test, cb) { return doWhilst(iteratee, function() { return !test.apply(this, arguments); |