doc: changed timer id to object
authorChristian <me@rndm.de>
Sun, 9 Feb 2014 09:37:55 +0000 (10:37 +0100)
committerFedor Indutny <fedor.indutny@gmail.com>
Wed, 12 Feb 2014 22:18:10 +0000 (02:18 +0400)
fix #7074

doc/api/timers.markdown

index 6bf1431..2ec7e1c 100644 (file)
@@ -8,7 +8,7 @@ this module in order to use them.
 ## setTimeout(callback, delay, [arg], [...])
 
 To schedule execution of a one-time `callback` after `delay` milliseconds. Returns a
-`timeoutId` for possible use with `clearTimeout()`. Optionally you can
+`timeoutObject` for possible use with `clearTimeout()`. Optionally you can
 also pass arguments to the callback.
 
 It is important to note that your callback will probably not be called in exactly
@@ -16,17 +16,17 @@ It is important to note that your callback will probably not be called in exactl
 the callback will fire, nor of the ordering things will fire in. The callback will
 be called as close as possible to the time specified.
 
-## clearTimeout(timeoutId)
+## clearTimeout(timeoutObject)
 
 Prevents a timeout from triggering.
 
 ## setInterval(callback, delay, [arg], [...])
 
 To schedule the repeated execution of `callback` every `delay` milliseconds.
-Returns a `intervalId` for possible use with `clearInterval()`. Optionally
+Returns a `intervalObject` for possible use with `clearInterval()`. Optionally
 you can also pass arguments to the callback.
 
-## clearInterval(intervalId)
+## clearInterval(intervalObject)
 
 Stops a interval from triggering.
 
@@ -51,7 +51,7 @@ request the timer hold the program open. If the timer is already `ref`d calling
 
 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
+`immediateObject` 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
@@ -61,6 +61,6 @@ will yield to the event loop after firing a queued callback to make sure I/O is
 not being starved. While order is preserved for execution, other I/O events may
 fire between any two scheduled immediate callbacks.
 
-## clearImmediate(immediateId)
+## clearImmediate(immediateObject)
 
 Stops an immediate from triggering.