Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: consolidate timers docs in timers.markdown #5837

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 27 additions & 24 deletions doc/api/globals.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -50,19 +50,23 @@ console.log(__filename);

`__filename` isn't actually a global but rather local to each module.

## clearInterval(t)
## clearImmediate(immediateObject)

Stop a timer that was previously created with [`setInterval()`][]. The callback
will not execute.
<!--type=global-->

[`clearImmediate`] is described in the [timers][] section.

## clearInterval(intervalObject)

<!--type=global-->

The timer functions are global variables. See the [timers][] section.
[`clearInterval`] is described in the [timers][] section.

## clearTimeout(t)
## clearTimeout(timeoutObject)

<!--type=global-->

Stop a timer that was previously created with [`setTimeout()`][]. The callback will
not execute.
[`clearTimeout`] is described in the [timers][] section.

## console

Expand Down Expand Up @@ -162,34 +166,33 @@ left untouched.
Use the internal `require()` machinery to look up the location of a module,
but rather than loading the module, just return the resolved filename.

## setInterval(cb, ms)
## setImmediate(callback[, arg][, ...])

Run callback `cb` repeatedly every `ms` milliseconds. Note that the actual
interval may vary, depending on external factors like OS timer granularity and
system load. It's never less than `ms` but it may be longer.
<!-- type=global -->

[`setImmediate`] is described in the [timers][] section.

The interval must be in the range of 1-2,147,483,647 inclusive. If the value is
outside that range, it's changed to 1 millisecond. Broadly speaking, a timer
cannot span more than 24.8 days.
## setInterval(callback, delay[, arg][, ...])

Returns an opaque value that represents the timer.
<!-- type=global -->

## setTimeout(cb, ms)
[`setInterval`] is described in the [timers][] section.

Run callback `cb` after *at least* `ms` milliseconds. The actual delay depends
on external factors like OS timer granularity and system load.
## setTimeout(callback, delay[, arg][, ...])

The timeout must be in the range of 1-2,147,483,647 inclusive. If the value is
outside that range, it's changed to 1 millisecond. Broadly speaking, a timer
cannot span more than 24.8 days.
<!-- type=global -->

Returns an opaque value that represents the timer.
[`setTimeout`] is described in the [timers][] section.

[`console`]: console.html
[`process` object]: process.html#process_process
[`setInterval()`]: #globals_setinterval_cb_ms
[`setTimeout()`]: #globals_settimeout_cb_ms
[buffer section]: buffer.html
[module system documentation]: modules.html
[Modules]: modules.html#modules_modules
[timers]: timers.html
[`clearImmediate`]: timers.html#timers_clearimmediate_immediateobject
[`clearInterval`]: timers.html#timers_clearinterval_intervalobject
[`clearTimeout`]: timers.html#timers_cleartimeout_timeoutobject
[`setImmediate`]: timers.html#timers_setimmediate_callback_arg
[`setInterval`]: timers.html#timers_setinterval_callback_delay_arg
[`setTimeout`]: timers.html#timers_settimeout_callback_delay_arg
6 changes: 3 additions & 3 deletions doc/api/timers.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Returns the timer.

## setImmediate(callback[, arg][, ...])

To schedule the "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
triggered. Returns an `immediateObject` for possible use with
[`clearImmediate`][]. Additional optional arguments may be passed to the
Expand All @@ -42,7 +42,7 @@ If `callback` is not a function `setImmediate()` will throw immediately.

## setInterval(callback, delay[, arg][, ...])

To schedule the repeated execution of `callback` every `delay` milliseconds.
Schedules repeated execution of `callback` every `delay` milliseconds.
Returns a `intervalObject` for possible use with [`clearInterval`][]. Additional
optional arguments may be passed to the callback.

Expand All @@ -54,7 +54,7 @@ If `callback` is not a function `setInterval()` will throw immediately.

## setTimeout(callback, delay[, arg][, ...])

To schedule 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
optional arguments may be passed to the callback.

Expand Down