Browse Source

doc refactor: timers

v0.8.7-release
isaacs 13 years ago
parent
commit
4ed05da2be
  1. 13
      doc/api/timers.markdown

13
doc/api/timers.markdown

@ -1,6 +1,9 @@
## Timers # Timers
### setTimeout(callback, delay, [arg], [...]) All of the timer functions are globals. You do not need to `require()`
this module in order to use them.
## setTimeout(callback, delay, [arg], [...])
To schedule execution of a one-time `callback` after `delay` milliseconds. Returns a To schedule execution of a one-time `callback` after `delay` milliseconds. Returns a
`timeoutId` for possible use with `clearTimeout()`. Optionally you can `timeoutId` for possible use with `clearTimeout()`. Optionally you can
@ -11,16 +14,16 @@ 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 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. be called as close as possible to the time specified.
### clearTimeout(timeoutId) ## clearTimeout(timeoutId)
Prevents a timeout from triggering. Prevents a timeout from triggering.
### setInterval(callback, delay, [arg], [...]) ## setInterval(callback, delay, [arg], [...])
To schedule the repeated execution of `callback` every `delay` milliseconds. To schedule the repeated execution of `callback` every `delay` milliseconds.
Returns a `intervalId` for possible use with `clearInterval()`. Optionally Returns a `intervalId` for possible use with `clearInterval()`. Optionally
you can also pass arguments to the callback. you can also pass arguments to the callback.
### clearInterval(intervalId) ## clearInterval(intervalId)
Stops a interval from triggering. Stops a interval from triggering.

Loading…
Cancel
Save