summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexander Early <alexander.early@gmail.com>2016-03-07 22:28:11 -0800
committerAlexander Early <alexander.early@gmail.com>2016-03-07 22:28:11 -0800
commit0736189b1d2909121656d79879726b031ea8ed87 (patch)
tree75eddc87a57d62efe654091ddd5c54da9d7efbb8 /README.md
parent0600652d67344373ba9885d4a7bb6087065c9634 (diff)
downloadasync-0736189b1d2909121656d79879726b031ea8ed87.tar.gz
pass extra args to setImmediate/nextTick. Fixes #940
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/README.md b/README.md
index c7ec1a1..d527b42 100644
--- a/README.md
+++ b/README.md
@@ -1568,7 +1568,7 @@ three
---------------------------------------
<a name="nextTick"></a>
-### nextTick(callback), setImmediate(callback)
+### nextTick(callback, [args...]), setImmediate(callback, [args...])
Calls `callback` on a later loop around the event loop. In Node.js this just
calls `process.nextTick`; in the browser it falls back to `setImmediate(callback)`
@@ -1580,6 +1580,7 @@ This is used internally for browser-compatibility purposes.
__Arguments__
* `callback` - The function to call on a later loop around the event loop.
+* `args...` - any number of additional arguments to pass to the callback on the next tick
__Example__
@@ -1590,6 +1591,10 @@ async.nextTick(function(){
// call_order now equals ['one','two']
});
call_order.push('one')
+
+async.setImmediate(function (a, b, c) {
+ // a, b, and c equal 1, 2, and 3
+}, 1, 2, 3)
```
---------------------------------------