summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Early <alexander.early@gmail.com>2016-05-05 16:42:34 -0700
committerAlexander Early <alexander.early@gmail.com>2016-05-05 16:42:34 -0700
commitdbba0215f19d980fcfa83fdcab631370dfb939bc (patch)
tree382d8f00c20e6634ccfabc389f29f6402dbfbedf
parent35a5f38770fb572db3a8c957055ac61812272a78 (diff)
downloadasync-dbba0215f19d980fcfa83fdcab631370dfb939bc.tar.gz
Clarify doWhilst/doUntil docs. Closes #1107
-rw-r--r--README.md4
-rw-r--r--lib/doUntil.js4
-rw-r--r--lib/doWhilst.js5
3 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index 80567f4..871f123 100644
--- a/README.md
+++ b/README.md
@@ -919,7 +919,7 @@ async.whilst(
### doWhilst(fn, test, callback)
The post-check version of [`whilst`](#whilst). To reflect the difference in
-the order of operations, the arguments `test` and `fn` are switched.
+the order of operations, the arguments `test` and `fn` are switched. The `test` function is also passed the non-error callback results of `fn`.
`doWhilst` is to `whilst` as `do while` is to `while` in plain JavaScript.
@@ -941,7 +941,7 @@ The inverse of [`whilst`](#whilst).
### doUntil(fn, test, callback)
-Like [`doWhilst`](#doWhilst), except the `test` is inverted. Note the argument ordering differs from `until`.
+Like [`doWhilst`](#doWhilst), except the `test` is inverted. Note the argument ordering differs from `until`. The `test` function is also passed the non-error callback results of `fn`.
---------------------------------------
diff --git a/lib/doUntil.js b/lib/doUntil.js
index 1ebdd3e..4e6bbc3 100644
--- a/lib/doUntil.js
+++ b/lib/doUntil.js
@@ -14,8 +14,8 @@ import doWhilst from './doWhilst';
* @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} test - synchronous truth test to perform after each
+ * execution of `fn`. Invoked with the non-error callback results of `fn`.
* @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
diff --git a/lib/doWhilst.js b/lib/doWhilst.js
index f49cf08..b38036b 100644
--- a/lib/doWhilst.js
+++ b/lib/doWhilst.js
@@ -16,8 +16,9 @@ import whilst from './whilst';
* @param {Function} fn - A function which is called each time `test` passes.
* 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} test - synchronous truth test to perform after each
+ * execution of `fn`. Invoked with Invoked with the non-error callback results
+ * of `fn`.
* @param {Function} [callback] - A callback which is called after the test
* function has failed and repeated execution of `fn` has stopped. `callback`
* will be passed an error and any arguments passed to the final `fn`'s