|
@ -1,30 +1,50 @@ |
|
|
## Global Objects |
|
|
# Global Objects |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=misc --> |
|
|
|
|
|
|
|
|
These objects are available in all modules. Some of these objects aren't |
|
|
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. |
|
|
actually in the global scope but in the module scope - this will be noted. |
|
|
|
|
|
|
|
|
### global |
|
|
## global |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=global --> |
|
|
|
|
|
|
|
|
The global namespace object. |
|
|
* {Object} The global namespace object. |
|
|
|
|
|
|
|
|
In browsers, the top-level scope is the global scope. That means that in |
|
|
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 |
|
|
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 |
|
|
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. |
|
|
scope; `var something` inside a Node module will be local to that module. |
|
|
|
|
|
|
|
|
### process |
|
|
## process |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=global --> |
|
|
|
|
|
|
|
|
|
|
|
* {Object} |
|
|
|
|
|
|
|
|
The process object. See the [process object](process.html#process) section. |
|
|
The process object. See the [process object](process.html#process) section. |
|
|
|
|
|
|
|
|
### console |
|
|
## console |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=global --> |
|
|
|
|
|
|
|
|
|
|
|
* {Object} |
|
|
|
|
|
|
|
|
Used to print to stdout and stderr. See the [stdio](stdio.html) section. |
|
|
Used to print to stdout and stderr. See the [stdio](stdio.html) section. |
|
|
|
|
|
|
|
|
### Buffer |
|
|
## Buffer |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=global --> |
|
|
|
|
|
|
|
|
|
|
|
* {Object} |
|
|
|
|
|
|
|
|
Used to handle binary data. See the [buffers](buffers.html) section. |
|
|
Used to handle binary data. See the [buffers](buffers.html) section. |
|
|
|
|
|
|
|
|
### require() |
|
|
## require() |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=var --> |
|
|
|
|
|
|
|
|
|
|
|
* {Function} |
|
|
|
|
|
|
|
|
To require modules. See the [Modules](modules.html#modules) section. |
|
|
To require modules. See the [Modules](modules.html#modules) section. |
|
|
`require` isn't actually a global but rather local to each module. |
|
|
`require` isn't actually a global but rather local to each module. |
|
@ -37,11 +57,16 @@ but rather than loading the module, just return the resolved filename. |
|
|
|
|
|
|
|
|
### require.cache |
|
|
### require.cache |
|
|
|
|
|
|
|
|
|
|
|
* {Object} |
|
|
|
|
|
|
|
|
Modules are cached in this object when they are required. By deleting a key |
|
|
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. |
|
|
value from this object, the next `require` will reload the module. |
|
|
|
|
|
|
|
|
|
|
|
## __filename |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=var --> |
|
|
|
|
|
|
|
|
### __filename |
|
|
* {String} |
|
|
|
|
|
|
|
|
The filename of the code being executed. This is the resolved absolute path |
|
|
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 |
|
|
of this code file. For a main program this is not necessarily the same |
|
@ -55,7 +80,11 @@ Example: running `node example.js` from `/Users/mjr` |
|
|
|
|
|
|
|
|
`__filename` isn't actually a global but rather local to each module. |
|
|
`__filename` isn't actually a global but rather local to each module. |
|
|
|
|
|
|
|
|
### __dirname |
|
|
## __dirname |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=var --> |
|
|
|
|
|
|
|
|
|
|
|
* {String} |
|
|
|
|
|
|
|
|
The name of the directory that the currently executing script resides in. |
|
|
The name of the directory that the currently executing script resides in. |
|
|
|
|
|
|
|
@ -67,7 +96,11 @@ Example: running `node example.js` from `/Users/mjr` |
|
|
`__dirname` isn't actually a global but rather local to each module. |
|
|
`__dirname` isn't actually a global but rather local to each module. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### module |
|
|
## module |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=var --> |
|
|
|
|
|
|
|
|
|
|
|
* {Object} |
|
|
|
|
|
|
|
|
A reference to the current module. In particular |
|
|
A reference to the current module. In particular |
|
|
`module.exports` is the same as the `exports` object. |
|
|
`module.exports` is the same as the `exports` object. |
|
@ -77,7 +110,9 @@ See the [module system documentation](modules.html) for more |
|
|
information. |
|
|
information. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### exports |
|
|
## exports |
|
|
|
|
|
|
|
|
|
|
|
<!-- type=var --> |
|
|
|
|
|
|
|
|
An object which is shared between all instances of the current module and |
|
|
An object which is shared between all instances of the current module and |
|
|
made accessible through `require()`. |
|
|
made accessible through `require()`. |
|
@ -87,9 +122,13 @@ made accessible through `require()`. |
|
|
See the [module system documentation](modules.html) for more |
|
|
See the [module system documentation](modules.html) for more |
|
|
information. |
|
|
information. |
|
|
|
|
|
|
|
|
### setTimeout(cb, ms) |
|
|
See the [module section](modules.html) for more information. |
|
|
### clearTimeout(t) |
|
|
|
|
|
### setInterval(cb, ms) |
|
|
## setTimeout(cb, ms) |
|
|
### clearInterval(t) |
|
|
## clearTimeout(t) |
|
|
|
|
|
## setInterval(cb, ms) |
|
|
|
|
|
## clearInterval(t) |
|
|
|
|
|
|
|
|
|
|
|
<!--type=global--> |
|
|
|
|
|
|
|
|
The timer functions are global variables. See the [timers](timers.html) section. |
|
|
The timer functions are global variables. See the [timers](timers.html) section. |
|
|