0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 15:06:33 +01:00
nodejs/doc/api/timers.markdown

32 lines
1.0 KiB
Markdown
Raw Normal View History

2012-02-27 20:09:34 +01:00
# Timers
2010-10-28 14:18:16 +02:00
Stability: 5 - Locked
2012-02-27 20:09:34 +01:00
All of the timer functions are globals. You do not need to `require()`
this module in order to use them.
## setTimeout(callback, delay, [arg], [...])
2010-10-28 14:18:16 +02:00
To schedule execution of a one-time `callback` after `delay` milliseconds. Returns a
`timeoutId` for possible use with `clearTimeout()`. Optionally you can
2010-10-28 14:18:16 +02:00
also pass arguments to the callback.
It is important to note that your callback will probably not be called in exactly
`delay` milliseconds - Node.js makes no guarantees about the exact timing of when
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.
2012-02-27 20:09:34 +01:00
## clearTimeout(timeoutId)
2010-10-28 14:18:16 +02:00
Prevents a timeout from triggering.
2012-02-27 20:09:34 +01:00
## setInterval(callback, delay, [arg], [...])
2010-10-28 14:18:16 +02:00
To schedule the repeated execution of `callback` every `delay` milliseconds.
Returns a `intervalId` for possible use with `clearInterval()`. Optionally
2010-10-28 14:18:16 +02:00
you can also pass arguments to the callback.
2012-02-27 20:09:34 +01:00
## clearInterval(intervalId)
2010-10-28 14:18:16 +02:00
Stops a interval from triggering.