node/doc/api/timers.markdown

# Timers

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
`timeoutId` 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
`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.

## clearTimeout(timeoutId)

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
you can also pass arguments to the callback.

## clearInterval(intervalId)

Stops a interval from triggering.
doc refactor: timers 13 years ago			`# Timers`
Splitting documentation 14 years ago
doc refactor: timers 13 years ago			All of the timer functions are globals. You do not need to `require()`
			`this module in order to use them.`

			`## setTimeout(callback, delay, [arg], [...])`
Splitting documentation 14 years ago
docs: typos and minor edits in several modules Mostly quite minor edits. Those possibly of more interest are: emitter.setMaxListeners(n) That the limit is per event name for an emitter. fs.readlink() Not a path, but rather the symbolic link's string value, which would be at best a partial path, certainly not a 'resolvedPath' global.__filename This may be "well-known" but this is a full path to the module that referencing code is running in. It is not the main program's path, unless you are in the main program. Each module knows only its own path. server.listen(port,...) I actually needed this functionality... "gimme just _any_ next port" stream.end() stream.destroy() Yeah, everybody knows what happens to the queued data, but let's make it really explicit for the first readers. 13 years ago			To schedule execution of a one-time `callback` after `delay` milliseconds. Returns a
			`timeoutId` for possible use with `clearTimeout()`. Optionally you can
Splitting documentation 14 years ago			`also pass arguments to the callback.`

Doc fixes Fixes #1701. Thanks baudehlo. 13 years ago			`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.`

doc refactor: timers 13 years ago			`## clearTimeout(timeoutId)`
Splitting documentation 14 years ago
			`Prevents a timeout from triggering.`

doc refactor: timers 13 years ago			`## setInterval(callback, delay, [arg], [...])`
Splitting documentation 14 years ago
			To schedule the repeated execution of `callback` every `delay` milliseconds.
docs: typos and minor edits in several modules Mostly quite minor edits. Those possibly of more interest are: emitter.setMaxListeners(n) That the limit is per event name for an emitter. fs.readlink() Not a path, but rather the symbolic link's string value, which would be at best a partial path, certainly not a 'resolvedPath' global.__filename This may be "well-known" but this is a full path to the module that referencing code is running in. It is not the main program's path, unless you are in the main program. Each module knows only its own path. server.listen(port,...) I actually needed this functionality... "gimme just _any_ next port" stream.end() stream.destroy() Yeah, everybody knows what happens to the queued data, but let's make it really explicit for the first readers. 13 years ago			Returns a `intervalId` for possible use with `clearInterval()`. Optionally
Splitting documentation 14 years ago			`you can also pass arguments to the callback.`

doc refactor: timers 13 years ago			`## clearInterval(intervalId)`
Splitting documentation 14 years ago
			`Stops a interval from triggering.`