doc: add setImmediate execute timing description
authorShigeki Ohtsu <ohtsu@iij.ad.jp>
Wed, 6 Feb 2013 02:14:24 +0000 (11:14 +0900)
committerisaacs <i@izs.me>
Sat, 16 Feb 2013 00:11:05 +0000 (16:11 -0800)
doc/api/timers.markdown

index a1e2d47..6bf1431 100644 (file)
@@ -49,9 +49,10 @@ request the timer hold the program open. If the timer is already `ref`d calling
 
 ## setImmediate(callback, [arg], [...])
 
-To schedule the "immediate" execution of `callback`. Returns an `immediateId`
-for possible use with `clearImmediate()`. Optionally you can also pass
-arguments to the callback.
+To schedule the "immediate" execution of `callback` after I/O events
+callbacks and before `setTimeout` and `setInterval` . Returns an
+`immediateId` for possible use with `clearImmediate()`. Optionally you
+can also pass arguments to the callback.
 
 Immediates are queued in the order created, and are popped off the queue once
 per loop iteration. This is different from `process.nextTick` which will