From 325f579deea5fbe13665902ef68ed8cbe5d1406b Mon Sep 17 00:00:00 2001 From: Tristian Flanagan Date: Wed, 4 Nov 2015 12:12:06 -0500 Subject: [PATCH] doc: sort globals alphabetically Reorders, with no contextual changes, the globals documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas Reviewed-By: James M Snell Reviewed-By: Jeremiah Senkpiel --- doc/api/globals.markdown | 193 +++++++++++++++++++++++------------------------ 1 file changed, 96 insertions(+), 97 deletions(-) diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown index 2a2140f..b9ab51a 100644 --- a/doc/api/globals.markdown +++ b/doc/api/globals.markdown @@ -5,33 +5,6 @@ These objects are available in all modules. Some of these objects aren't actually in the global scope but in the module scope - this will be noted. -## global - - - -* {Object} The global namespace object. - -In browsers, the top-level scope is the global scope. That means that in -browsers if you're in the global scope `var something` will define a global -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. - -## process - - - -* {Object} - -The process object. See the [process object][] section. - -## console - - - -* {Object} - -Used to print to stdout and stderr. See the [console][] section. - ## Class: Buffer @@ -40,48 +13,20 @@ Used to print to stdout and stderr. See the [console][] section. Used to handle binary data. See the [buffer section][] -## require() +## __dirname -* {Function} - -To require modules. See the [Modules][] section. `require` isn't actually a -global but rather local to each module. - -### 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. - -### require.cache - -* {Object} - -Modules are cached in this object when they are required. By deleting a key -value from this object, the next `require` will reload the module. - -### require.extensions - - Stability: 0 - Deprecated - -* {Object} - -Instruct `require` on how to handle certain file extensions. +* {String} -Process files with the extension `.sjs` as `.js`: +The name of the directory that the currently executing script resides in. - require.extensions['.sjs'] = require.extensions['.js']; +Example: running `node example.js` from `/Users/mjr` -**Deprecated** In the past, this list has been used to load -non-JavaScript modules into Node.js by compiling them on-demand. -However, in practice, there are much better ways to do this, such as -loading modules via some other Node.js program, or compiling them to -JavaScript ahead of time. + console.log(__dirname); + // /Users/mjr -Since the Module system is locked, this feature will probably never go -away. However, it may have subtle bugs and complexities that are best -left untouched. +`__dirname` isn't actually a global but rather local to each module. ## __filename @@ -101,21 +46,57 @@ Example: running `node example.js` from `/Users/mjr` `__filename` isn't actually a global but rather local to each module. -## __dirname +## clearInterval(t) + +Stop a timer that was previously created with `setInterval()`. The callback +will not execute. + + + +The timer functions are global variables. See the [timers][] section. + +[buffer section]: buffer.html +[module system documentation]: modules.html +[Modules]: modules.html#modules_modules +[process object]: process.html#process_process +[console]: console.html +[timers]: timers.html + +## clearTimeout(t) + +Stop a timer that was previously created with `setTimeout()`. The callback will +not execute. + +## console + + + +* {Object} + +Used to print to stdout and stderr. See the [console][] section. + +## exports -* {String} +A reference to the `module.exports` that is shorter to type. +See [module system documentation][] for details on when to use `exports` and +when to use `module.exports`. -The name of the directory that the currently executing script resides in. +`exports` isn't actually a global but rather local to each module. -Example: running `node example.js` from `/Users/mjr` +See the [module system documentation][] for more information. - console.log(__dirname); - // /Users/mjr +## global -`__dirname` isn't actually a global but rather local to each module. + + +* {Object} The global namespace object. +In browsers, the top-level scope is the global scope. That means that in +browsers if you're in the global scope `var something` will define a global +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 @@ -131,33 +112,56 @@ available through `require()`. See the [module system documentation][] for more information. -## exports +## process + + + +* {Object} + +The process object. See the [process object][] section. + +## require() -A reference to the `module.exports` that is shorter to type. -See [module system documentation][] for details on when to use `exports` and -when to use `module.exports`. +* {Function} -`exports` isn't actually a global but rather local to each module. +To require modules. See the [Modules][] section. `require` isn't actually a +global but rather local to each module. -See the [module system documentation][] for more information. +### require.cache -## setTimeout(cb, ms) +* {Object} -Run callback `cb` after *at least* `ms` milliseconds. The actual delay depends -on external factors like OS timer granularity and system load. +Modules are cached in this object when they are required. By deleting a key +value from this object, the next `require` will reload the module. -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. +### require.extensions -Returns an opaque value that represents the timer. + Stability: 0 - Deprecated -## clearTimeout(t) +* {Object} -Stop a timer that was previously created with `setTimeout()`. The callback will -not execute. +Instruct `require` on how to handle certain file extensions. + +Process files with the extension `.sjs` as `.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. +However, in practice, there are much better ways to do this, such as +loading modules via some other Node.js program, or compiling them to +JavaScript ahead of time. + +Since the Module system is locked, this feature will probably never go +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. ## setInterval(cb, ms) @@ -171,18 +175,13 @@ cannot span more than 24.8 days. Returns an opaque value that represents the timer. -## clearInterval(t) - -Stop a timer that was previously created with `setInterval()`. The callback -will not execute. +## setTimeout(cb, ms) - +Run callback `cb` after *at least* `ms` milliseconds. The actual delay depends +on external factors like OS timer granularity and system load. -The timer functions are global variables. See the [timers][] section. +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. -[buffer section]: buffer.html -[module system documentation]: modules.html -[Modules]: modules.html#modules_modules -[process object]: process.html#process_process -[console]: console.html -[timers]: timers.html +Returns an opaque value that represents the timer. -- 2.7.4