doc: consolidate timers docs in timers.markdown

[platform/upstream/nodejs.git] / doc / api / globals.markdown

diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown
index a8998d7..94fc332 100644 (file)
--- a/doc/api/globals.markdown
+++ b/doc/api/globals.markdown
@@ -23,8 +23,10 @@ The name of the directory that the currently executing script resides in.
 
 Example: running `node example.js` from `/Users/mjr`
 
-    console.log(__dirname);
-    // /Users/mjr
+```js
+console.log(__dirname);
+// /Users/mjr
+```
 
 `__dirname` isn't actually a global but rather local to each module.
 
@@ -41,24 +43,30 @@ to that module file.
 
 Example: running `node example.js` from `/Users/mjr`
 
-    console.log(__filename);
-    // /Users/mjr/example.js
+```js
+console.log(__filename);
+// /Users/mjr/example.js
+```
 
 `__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
 
@@ -139,7 +147,9 @@ Instruct `require` on how to handle certain file extensions.
 
 Process files with the extension `.sjs` as `.js`:
 
-    require.extensions['.sjs'] = require.extensions['.js'];
+```js
+require.extensions['.sjs'] = require.extensions['.js'];
+```
 
 **Deprecated**  In the past, this list has been used to load
 non-JavaScript modules into Node.js by compiling them on-demand.
@@ -156,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