|
@ -6,18 +6,30 @@ All of the timer functions are globals. You do not need to `require()` |
|
|
this module in order to use them. |
|
|
this module in order to use them. |
|
|
|
|
|
|
|
|
## clearImmediate(immediateObject) |
|
|
## clearImmediate(immediateObject) |
|
|
|
|
|
<!-- YAML |
|
|
|
|
|
added: v0.9.1 |
|
|
|
|
|
--> |
|
|
|
|
|
|
|
|
Stops an `immediateObject`, as created by [`setImmediate`][], from triggering. |
|
|
Stops an `immediateObject`, as created by [`setImmediate`][], from triggering. |
|
|
|
|
|
|
|
|
## clearInterval(intervalObject) |
|
|
## clearInterval(intervalObject) |
|
|
|
|
|
<!-- YAML |
|
|
|
|
|
added: v0.0.1 |
|
|
|
|
|
--> |
|
|
|
|
|
|
|
|
Stops an `intervalObject`, as created by [`setInterval`][], from triggering. |
|
|
Stops an `intervalObject`, as created by [`setInterval`][], from triggering. |
|
|
|
|
|
|
|
|
## clearTimeout(timeoutObject) |
|
|
## clearTimeout(timeoutObject) |
|
|
|
|
|
<!-- YAML |
|
|
|
|
|
added: v0.0.1 |
|
|
|
|
|
--> |
|
|
|
|
|
|
|
|
Prevents a `timeoutObject`, as created by [`setTimeout`][], from triggering. |
|
|
Prevents a `timeoutObject`, as created by [`setTimeout`][], from triggering. |
|
|
|
|
|
|
|
|
## ref() |
|
|
## ref() |
|
|
|
|
|
<!-- YAML |
|
|
|
|
|
added: v0.9.1 |
|
|
|
|
|
--> |
|
|
|
|
|
|
|
|
If a timer was previously `unref()`d, then `ref()` can be called to explicitly |
|
|
If a timer was previously `unref()`d, then `ref()` can be called to explicitly |
|
|
request the timer hold the program open. If the timer is already `ref`d calling |
|
|
request the timer hold the program open. If the timer is already `ref`d calling |
|
@ -26,6 +38,9 @@ request the timer hold the program open. If the timer is already `ref`d calling |
|
|
Returns the timer. |
|
|
Returns the timer. |
|
|
|
|
|
|
|
|
## setImmediate(callback[, arg][, ...]) |
|
|
## setImmediate(callback[, arg][, ...]) |
|
|
|
|
|
<!-- YAML |
|
|
|
|
|
added: v0.9.1 |
|
|
|
|
|
--> |
|
|
|
|
|
|
|
|
Schedules "immediate" execution of `callback` after I/O events' |
|
|
Schedules "immediate" execution of `callback` after I/O events' |
|
|
callbacks and before timers set by [`setTimeout`][] and [`setInterval`][] are |
|
|
callbacks and before timers set by [`setTimeout`][] and [`setInterval`][] are |
|
@ -39,6 +54,9 @@ immediate is queued from inside an executing callback, that immediate won't fire |
|
|
until the next event loop iteration. |
|
|
until the next event loop iteration. |
|
|
|
|
|
|
|
|
## setInterval(callback, delay[, arg][, ...]) |
|
|
## setInterval(callback, delay[, arg][, ...]) |
|
|
|
|
|
<!-- YAML |
|
|
|
|
|
added: v0.0.1 |
|
|
|
|
|
--> |
|
|
|
|
|
|
|
|
Schedules repeated execution of `callback` every `delay` milliseconds. |
|
|
Schedules repeated execution of `callback` every `delay` milliseconds. |
|
|
Returns a `intervalObject` for possible use with [`clearInterval`][]. Additional |
|
|
Returns a `intervalObject` for possible use with [`clearInterval`][]. Additional |
|
@ -49,6 +67,9 @@ milliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the |
|
|
`delay`. |
|
|
`delay`. |
|
|
|
|
|
|
|
|
## setTimeout(callback, delay[, arg][, ...]) |
|
|
## setTimeout(callback, delay[, arg][, ...]) |
|
|
|
|
|
<!-- YAML |
|
|
|
|
|
added: v0.0.1 |
|
|
|
|
|
--> |
|
|
|
|
|
|
|
|
Schedules execution of a one-time `callback` after `delay` milliseconds. |
|
|
Schedules execution of a one-time `callback` after `delay` milliseconds. |
|
|
Returns a `timeoutObject` for possible use with [`clearTimeout`][]. Additional |
|
|
Returns a `timeoutObject` for possible use with [`clearTimeout`][]. Additional |
|
@ -64,6 +85,9 @@ milliseconds (approximately 25 days) or less than 1, the timeout is executed |
|
|
immediately, as if the `delay` was set to 1. |
|
|
immediately, as if the `delay` was set to 1. |
|
|
|
|
|
|
|
|
## unref() |
|
|
## unref() |
|
|
|
|
|
<!-- YAML |
|
|
|
|
|
added: v0.9.1 |
|
|
|
|
|
--> |
|
|
|
|
|
|
|
|
The opaque value returned by [`setTimeout`][] and [`setInterval`][] also has the |
|
|
The opaque value returned by [`setTimeout`][] and [`setInterval`][] also has the |
|
|
method `timer.unref()` which allows the creation of a timer that is active but |
|
|
method `timer.unref()` which allows the creation of a timer that is active but |
|
|