diff options
author | Hubert Argasinski <argasinski.hubert@gmail.com> | 2016-03-31 02:22:16 -0700 |
---|---|---|
committer | Graeme Yeates <yeatesgraeme@gmail.com> | 2016-04-12 18:46:28 -0400 |
commit | 8eb2a7cec2c62edf35d7b812765bd64e6b7d484f (patch) | |
tree | 76a0c7715c612acddd9e6801dc14ec43f768176f /lib/until.js | |
parent | a778ee63788d533111ff63b611cc5034e18a907f (diff) | |
download | async-8eb2a7cec2c62edf35d7b812765bd64e6b7d484f.tar.gz |
jsdoc-style documentation began documenting `Control Flow` methods
remaining `Control Flow` methods to document:
- queue
- priorityQueue
- cargo
- auto
- autoInject
- retry
- retryable
- iterator
- times, timesSeries, timesLimit
- race
Diffstat (limited to 'lib/until.js')
-rw-r--r-- | lib/until.js | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/until.js b/lib/until.js index b1283f2..0c5a1aa 100644 --- a/lib/until.js +++ b/lib/until.js @@ -2,6 +2,28 @@ import whilst from './whilst'; +/** + * Repeatedly call `fn` until `test` returns `true`. Calls `callback` when + * stopped, or an error occurs. `callback` will be passed an error and any + * arguments passed to the final `fn`'s callback. + * + * The inverse of [`whilst`](#whilst). + * + * @name until + * @static + * @memberOf async + * @see `async.whilst` + * @category Control Flow + * @param {Function} test - synchronous truth test to perform before each + * execution of `fn`. Invoked with (). + * @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} [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 until(test, iteratee, cb) { return whilst(function() { return !test.apply(this, arguments); |