From 033112450707e11cdfff34aa5b529595f9f8c18a Mon Sep 17 00:00:00 2001 From: jkroso Date: Thu, 29 Nov 2012 22:44:46 +1300 Subject: added post loop docs --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 1430894..dbbf670 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,9 @@ So far its been tested in IE6, IE7, IE8, FF3.6 and Chrome 5. Usage: * [series](#series) * [parallel](#parallel) * [whilst](#whilst) +* [doWhilst](#doWhilst) * [until](#until) +* [doUntil](#doUntil) * [waterfall](#waterfall) * [queue](#queue) * [auto](#auto) @@ -664,6 +666,13 @@ async.whilst( --------------------------------------- + +### doWhilst(fn, test, callback) + +The post check version of whilst. To reflect the difference in the order of operations `test` and `fn` arguments are switched. `doWhilst` is to `whilst` as `do while` is to `while` in plain JavaScript. + +--------------------------------------- + ### until(test, fn, callback) @@ -672,6 +681,13 @@ or an error occurs. The inverse of async.whilst. +--------------------------------------- + + +### doUntil(fn, test, callback) + +Like doWhilst except the test is inverted. Note the argument ordering differs from `until`. + --------------------------------------- -- cgit v1.2.1