summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatt Perpick <clutchski@gmail.com>2012-01-16 04:07:08 -0500
committerMatt Perpick <clutchski@gmail.com>2012-01-16 04:07:08 -0500
commit751cd30602545db170b6f508a222b03e53598548 (patch)
tree901b115291419a21d08f2ac5358ffde13abbabe7 /README.md
parentf7fec588ee9d53c22e2009a7e38e386c7d5b7ce4 (diff)
downloadasync-751cd30602545db170b6f508a222b03e53598548.tar.gz
Waterfall docs now show final result passing.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 94ee562..8e8155f 100644
--- a/README.md
+++ b/README.md
@@ -654,8 +654,10 @@ __Arguments__
* tasks - An array of functions to run, each function is passed a callback it
must call on completion.
-* callback(err) - An optional callback to run once all the functions have
- completed. This function gets passed any error that may have occurred.
+* callback(err, [results]) - An optional callback to run once all the functions
+ have completed. This will be passed the results of the last task's callback.
+
+
__Example__
@@ -670,7 +672,9 @@ __Example__
// arg1 now equals 'three'
callback(null, 'done');
}
- ]);
+ ], function (err, result) {
+ // result now equals 'done'
+ });
---------------------------------------