X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fapi%2Fglobals.markdown;h=94fc332f94ac326b5b1c622472a0905d54140156;hb=940d2044013ef3014624eb3192cd02b913298484;hp=4fb8613382303da6ddf117d10d7fb836917bad55;hpb=5ac6f4de13bb2f18c264dfccfdcfea5a9118d43e;p=platform%2Fupstream%2Fnodejs.git diff --git a/doc/api/globals.markdown b/doc/api/globals.markdown index 4fb8613..94fc332 100644 --- a/doc/api/globals.markdown +++ b/doc/api/globals.markdown @@ -5,117 +5,99 @@ 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 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 +## Class: Buffer -* {Object} - -The process object. See the [process object][] section. +* {Function} -## console +Used to handle binary data. See the [buffer section][]. - +## \_\_dirname -* {Object} + -Used to print to stdout and stderr. See the [console][] section. +* {String} -## Class: Buffer +The name of the directory that the currently executing script resides in. - +Example: running `node example.js` from `/Users/mjr` -* {Function} +```js +console.log(__dirname); +// /Users/mjr +``` -Used to handle binary data. See the [buffer section][] +`__dirname` isn't actually a global but rather local to each module. -## require() +## \_\_filename -* {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 +* {String} -* {Object} +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. -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. +Example: running `node example.js` from `/Users/mjr` -### require.extensions +```js +console.log(__filename); +// /Users/mjr/example.js +``` - Stability: 0 - Deprecated +`__filename` isn't actually a global but rather local to each module. -* {Object} +## clearImmediate(immediateObject) -Instruct `require` on how to handle certain file extensions. + -Process files with the extension `.sjs` as `.js`: +[`clearImmediate`] is described in the [timers][] section. - require.extensions['.sjs'] = require.extensions['.js']; +## clearInterval(intervalObject) -**Deprecated** In the past, this list has been used to load -non-JavaScript modules into Node by compiling them on-demand. -However, in practice, there are much better ways to do this, such as -loading modules via some other Node 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. +[`clearInterval`] is described in the [timers][] section. -## __filename +## clearTimeout(timeoutObject) - + -* {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` + - 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 -* {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,61 +113,86 @@ 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 -See the [module section][] for more information. +* {Object} -## setTimeout(cb, ms) +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. -Run callback `cb` after *at least* `ms` milliseconds. The actual delay depends -on external factors like OS timer granularity and system load. +### require.extensions -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. + Stability: 0 - Deprecated -Returns an opaque value that represents the timer. +* {Object} -## clearTimeout(t) +Instruct `require` on how to handle certain file extensions. -Stop a timer that was previously created with `setTimeout()`. The callback will -not execute. +Process files with the extension `.sjs` as `.js`: -## setInterval(cb, ms) +```js +require.extensions['.sjs'] = require.extensions['.js']; +``` -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. +**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. -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. +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. -Returns an opaque value that represents the timer. +### require.resolve() -## clearInterval(t) +Use the internal `require()` machinery to look up the location of a module, +but rather than loading the module, just return the resolved filename. -Stop a timer that was previously created with `setInterval()`. The callback -will not execute. +## 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][, ...]) + + -The timer functions are global variables. See the [timers][] section. +[`setTimeout`] is described in the [timers][] section. +[`console`]: console.html +[`process` object]: process.html#process_process [buffer section]: buffer.html -[module section]: modules.html [module system documentation]: modules.html [Modules]: modules.html#modules_modules -[process object]: process.html#process_process -[console]: console.html [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