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
+## Class: Buffer
<!-- type=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 this is different. The top-level scope is not the global
-scope; `var something` inside a Node module will be local to that module.
-
-## process
+* {Function}
-<!-- type=global -->
+Used to handle binary data. See the [buffer section][].
-* {Object}
+## \_\_dirname
-The process object. See the [process object](process.html#process) section.
+<!-- type=var -->
-## console
+* {String}
-<!-- type=global -->
+The name of the directory that the currently executing script resides in.
-* {Object}
+Example: running `node example.js` from `/Users/mjr`
-Used to print to stdout and stderr. See the [stdio](stdio.html) section.
+```js
+console.log(__dirname);
+// /Users/mjr
+```
-## Buffer
+`__dirname` isn't actually a global but rather local to each module.
-<!-- type=global -->
+## \_\_filename
-* {Object}
+<!-- type=var -->
-Used to handle binary data. See the [buffers](buffers.html) section.
+* {String}
-## require()
+The filename of the code being executed. This is the resolved absolute path
+of this code file. For a main program this is not necessarily the same
+filename used in the command line. The value inside a module is the path
+to that module file.
-<!-- type=var -->
+Example: running `node example.js` from `/Users/mjr`
-* {Function}
+```js
+console.log(__filename);
+// /Users/mjr/example.js
+```
-To require modules. See the [Modules](modules.html#modules) section.
-`require` isn't actually a global but rather local to each module.
+`__filename` isn't actually a global but rather local to each module.
+## clearImmediate(immediateObject)
-### require.resolve()
+<!--type=global-->
-Use the internal `require()` machinery to look up the location of a module,
-but rather than loading the module, just return the resolved filename.
+[`clearImmediate`] is described in the [timers][] section.
-### require.cache
+## clearInterval(intervalObject)
-* {Object}
+<!--type=global-->
-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.
+[`clearInterval`] is described in the [timers][] section.
-## __filename
+## clearTimeout(timeoutObject)
-<!-- type=var -->
+<!--type=global-->
-* {String}
+[`clearTimeout`] is described in the [timers][] section.
-The filename of the code being executed. This is the resolved absolute path
-of this code file. For a main program this is not necessarily the same
-filename used in the command line. The value inside a module is the path
-to that module file.
+## console
-Example: running `node example.js` from `/Users/mjr`
+<!-- type=global -->
- console.log(__filename);
- // /Users/mjr/example.js
+* {Object}
-`__filename` isn't actually a global but rather local to each module.
+Used to print to stdout and stderr. See the [`console`][] section.
-## __dirname
+## exports
<!-- type=var -->
-* {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.
+<!-- type=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.
## module
* {Object}
A reference to the current module. In particular
-`module.exports` is the same as the `exports` object. See `src/node.js`
-for more information.
+`module.exports` is used for defining what a module exports and makes
+available through `require()`.
+
`module` isn't actually a global but rather local to each module.
+See the [module system documentation][] for more information.
-## exports
+## process
+
+<!-- type=global -->
+
+* {Object}
+
+The process object. See the [`process` object][] section.
+
+## require()
<!-- type=var -->
-An object which is shared between all instances of the current module and
-made accessible through `require()`.
-`exports` is the same as the `module.exports` object. See `src/node.js`
-for more information.
-`exports` isn't actually a global but rather local to each module.
+* {Function}
-See the [module system documentation](modules.html) for more
-information.
+To require modules. See the [Modules][] section. `require` isn't actually a
+global but rather local to each module.
-See the [module section](modules.html) for more information.
+### require.cache
-## setTimeout(cb, ms)
-## clearTimeout(t)
-## setInterval(cb, ms)
-## clearInterval(t)
+* {Object}
-<!--type=global-->
+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.
+
+Process files with the extension `.sjs` as `.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.
+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.
+
+## setImmediate(callback[, arg][, ...])
+
+<!-- type=global -->
+
+[`setImmediate`] is described in the [timers][] section.
+
+## setInterval(callback, delay[, arg][, ...])
+
+<!-- type=global -->
+
+[`setInterval`] is described in the [timers][] section.
+
+## setTimeout(callback, delay[, arg][, ...])
+
+<!-- type=global -->
-The timer functions are global variables. See the [timers](timers.html) section.
+[`setTimeout`] is described in the [timers][] section.
+
+[`console`]: console.html
+[`process` object]: process.html#process_process
+[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
projects / platform / upstream / nodejs.git / blobdiff