From 6fb2ef4a98a793f9e9af65bef27f0810081431fe Mon Sep 17 00:00:00 2001 From: Luigi Pinca Date: Mon, 3 Oct 2016 10:49:29 +0200 Subject: [PATCH] doc: add `added:` information for globals Ref: https://github.com/nodejs/node/issues/6578 Ref: https://github.com/nodejs/node/pull/8964 PR-URL: https://github.com/nodejs/node/pull/8901 Reviewed-By: James M Snell Reviewed-By: Roman Reiss Reviewed-By: Anna Henningsen --- doc/api/globals.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/doc/api/globals.md b/doc/api/globals.md index 0121a5269d27c1..dceff6e3ae7ccc 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -10,6 +10,9 @@ The objects listed here are specific to Node.js. There are a number of also globally accessible. ## Class: Buffer + @@ -18,6 +21,9 @@ also globally accessible. Used to handle binary data. See the [buffer section][]. ## \_\_dirname + @@ -45,6 +51,9 @@ References to `__dirname` within `b.js` will return will return `/Users/mjr/app`. ## \_\_filename + @@ -65,24 +74,36 @@ console.log(__filename); `__filename` isn't actually a global but rather local to each module. ## clearImmediate(immediateObject) + [`clearImmediate`] is described in the [timers][] section. ## clearInterval(intervalObject) + [`clearInterval`] is described in the [timers][] section. ## clearTimeout(timeoutObject) + [`clearTimeout`] is described in the [timers][] section. ## console + @@ -91,6 +112,9 @@ console.log(__filename); Used to print to stdout and stderr. See the [`console`][] section. ## exports + @@ -103,6 +127,9 @@ when to use `module.exports`. See the [module system documentation][] for more information. ## global + @@ -114,6 +141,9 @@ variable. In Node.js this is different. The top-level scope is not the global scope; `var something` inside an Node.js module will be local to that module. ## module + @@ -128,6 +158,9 @@ available through `require()`. See the [module system documentation][] for more information. ## process + @@ -136,6 +169,9 @@ See the [module system documentation][] for more information. The process object. See the [`process` object][] section. ## require() + @@ -145,6 +181,9 @@ To require modules. See the [Modules][] section. `require` isn't actually a global but rather local to each module. ### require.cache + * {Object} @@ -154,6 +193,10 @@ this does not apply to [native addons][], for which reloading will result in an Error. ### require.extensions + > Stability: 0 - Deprecated @@ -178,23 +221,35 @@ away. However, it may have subtle bugs and complexities that are best left untouched. ### require.resolve() + Use the internal `require()` machinery to look up the location of a module, but rather than loading the module, just return the resolved filename. ## setImmediate(callback[, arg][, ...]) + [`setImmediate`] is described in the [timers][] section. ## setInterval(callback, delay[, arg][, ...]) + [`setInterval`] is described in the [timers][] section. ## setTimeout(callback, delay[, arg][, ...]) +