/
usr
/
share
/
doc
/
nodejs-doc
/
api
/
Upload File
HOME
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>Global Objects | Node.js v8.10.0 Documentation</title> <link rel="stylesheet" href="assets/style.css"> <link rel="stylesheet" href="assets/sh.css"> <link rel="canonical" href="globals.html"> </head> <body class="alt apidoc" id="api-section-globals"> <div id="content" class="clearfix"> <div id="column2" class="interior"> <div id="intro" class="interior"> <a href="/" title="Go back to the home page"> Node.js </a> </div> <ul> <li><a class="nav-documentation" href="documentation.html">About these Docs</a></li> <li><a class="nav-synopsis" href="synopsis.html">Usage & Example</a></li> </ul> <div class="line"></div> <ul> <li><a class="nav-assert" href="assert.html">Assertion Testing</a></li> <li><a class="nav-async_hooks" href="async_hooks.html">Async Hooks</a></li> <li><a class="nav-buffer" href="buffer.html">Buffer</a></li> <li><a class="nav-addons" href="addons.html">C++ Addons</a></li> <li><a class="nav-n-api" href="n-api.html">C/C++ Addons - N-API</a></li> <li><a class="nav-child_process" href="child_process.html">Child Processes</a></li> <li><a class="nav-cluster" href="cluster.html">Cluster</a></li> <li><a class="nav-cli" href="cli.html">Command Line Options</a></li> <li><a class="nav-console" href="console.html">Console</a></li> <li><a class="nav-crypto" href="crypto.html">Crypto</a></li> <li><a class="nav-debugger" href="debugger.html">Debugger</a></li> <li><a class="nav-deprecations" href="deprecations.html">Deprecated APIs</a></li> <li><a class="nav-dns" href="dns.html">DNS</a></li> <li><a class="nav-domain" href="domain.html">Domain</a></li> <li><a class="nav-esm" href="esm.html">ECMAScript Modules</a></li> <li><a class="nav-errors" href="errors.html">Errors</a></li> <li><a class="nav-events" href="events.html">Events</a></li> <li><a class="nav-fs" href="fs.html">File System</a></li> <li><a class="nav-globals active" href="globals.html">Globals</a></li> <li><a class="nav-http" href="http.html">HTTP</a></li> <li><a class="nav-http2" href="http2.html">HTTP/2</a></li> <li><a class="nav-https" href="https.html">HTTPS</a></li> <li><a class="nav-inspector" href="inspector.html">Inspector</a></li> <li><a class="nav-intl" href="intl.html">Internationalization</a></li> <li><a class="nav-modules" href="modules.html">Modules</a></li> <li><a class="nav-net" href="net.html">Net</a></li> <li><a class="nav-os" href="os.html">OS</a></li> <li><a class="nav-path" href="path.html">Path</a></li> <li><a class="nav-perf_hooks" href="perf_hooks.html">Performance Hooks</a></li> <li><a class="nav-process" href="process.html">Process</a></li> <li><a class="nav-punycode" href="punycode.html">Punycode</a></li> <li><a class="nav-querystring" href="querystring.html">Query Strings</a></li> <li><a class="nav-readline" href="readline.html">Readline</a></li> <li><a class="nav-repl" href="repl.html">REPL</a></li> <li><a class="nav-stream" href="stream.html">Stream</a></li> <li><a class="nav-string_decoder" href="string_decoder.html">String Decoder</a></li> <li><a class="nav-timers" href="timers.html">Timers</a></li> <li><a class="nav-tls" href="tls.html">TLS/SSL</a></li> <li><a class="nav-tracing" href="tracing.html">Tracing</a></li> <li><a class="nav-tty" href="tty.html">TTY</a></li> <li><a class="nav-dgram" href="dgram.html">UDP/Datagram</a></li> <li><a class="nav-url" href="url.html">URL</a></li> <li><a class="nav-util" href="util.html">Utilities</a></li> <li><a class="nav-v8" href="v8.html">V8</a></li> <li><a class="nav-vm" href="vm.html">VM</a></li> <li><a class="nav-zlib" href="zlib.html">ZLIB</a></li> </ul> <div class="line"></div> <ul> <li><a class="nav-https-github-com-nodejs-node" href="https://github.com/nodejs/node">GitHub Repo & Issue Tracker</a></li> <li><a class="nav-https-groups-google-com-group-nodejs" href="https://groups.google.com/group/nodejs">Mailing List</a></li> </ul> </div> <div id="column1" data-id="globals" class="interior"> <header> <h1>Node.js v8.10.0 Documentation</h1> <div id="gtoc"> <ul> <li> <a href="index.html" name="toc">Index</a> </li> <li> <a href="all.html">View on single page</a> </li> <li> <a href="globals.json">View as JSON</a> </li> <li class="version-picker"> <a href="#">View another version <span>▼</span></a> <ol class="version-picker"><li><a href="https://nodejs.org/docs/latest-v9.x/api/globals.html">9.x</a></li> <li><a href="https://nodejs.org/docs/latest-v8.x/api/globals.html">8.x <b>LTS</b></a></li> <li><a href="https://nodejs.org/docs/latest-v7.x/api/globals.html">7.x</a></li> <li><a href="https://nodejs.org/docs/latest-v6.x/api/globals.html">6.x <b>LTS</b></a></li> <li><a href="https://nodejs.org/docs/latest-v5.x/api/globals.html">5.x</a></li> <li><a href="https://nodejs.org/docs/latest-v4.x/api/globals.html">4.x <b>LTS</b></a></li> <li><a href="https://nodejs.org/docs/latest-v0.12.x/api/globals.html">0.12.x</a></li> <li><a href="https://nodejs.org/docs/latest-v0.10.x/api/globals.html">0.10.x</a></li></ol> </li> </ul> </div> <hr> </header> <div id="toc"> <h2>Table of Contents</h2> <ul> <li><span class="stability_undefined"><a href="#globals_global_objects">Global Objects</a></span><ul> <li><span class="stability_undefined"><a href="#globals_class_buffer">Class: Buffer</a></span></li> <li><span class="stability_undefined"><a href="#globals_dirname">__dirname</a></span></li> <li><span class="stability_undefined"><a href="#globals_filename">__filename</a></span></li> <li><span class="stability_undefined"><a href="#globals_clearimmediate_immediateobject">clearImmediate(immediateObject)</a></span></li> <li><span class="stability_undefined"><a href="#globals_clearinterval_intervalobject">clearInterval(intervalObject)</a></span></li> <li><span class="stability_undefined"><a href="#globals_cleartimeout_timeoutobject">clearTimeout(timeoutObject)</a></span></li> <li><span class="stability_undefined"><a href="#globals_console">console</a></span></li> <li><span class="stability_undefined"><a href="#globals_exports">exports</a></span></li> <li><span class="stability_undefined"><a href="#globals_global">global</a></span></li> <li><span class="stability_undefined"><a href="#globals_module">module</a></span></li> <li><span class="stability_undefined"><a href="#globals_process">process</a></span></li> <li><span class="stability_undefined"><a href="#globals_require">require()</a></span></li> <li><span class="stability_undefined"><a href="#globals_setimmediate_callback_args">setImmediate(callback[, ...args])</a></span></li> <li><span class="stability_undefined"><a href="#globals_setinterval_callback_delay_args">setInterval(callback, delay[, ...args])</a></span></li> <li><span class="stability_undefined"><a href="#globals_settimeout_callback_delay_args">setTimeout(callback, delay[, ...args])</a></span></li> </ul> </li> </ul> </div> <div id="apicontent"> <h1>Global Objects<span><a class="mark" href="#globals_global_objects" id="globals_global_objects">#</a></span></h1> <!--introduced_in=v0.10.0--> <!-- type=misc --> <p>These objects are available in all modules. The following variables may appear to be global but are not. They exist only in the scope of modules, see the <a href="modules.html">module system documentation</a>:</p> <ul> <li><a href="modules.html#modules_dirname"><code>__dirname</code></a></li> <li><a href="modules.html#modules_filename"><code>__filename</code></a></li> <li><a href="modules.html#modules_exports"><code>exports</code></a></li> <li><a href="modules.html#modules_module"><code>module</code></a></li> <li><a href="modules.html#modules_require"><code>require()</code></a></li> </ul> <p>The objects listed here are specific to Node.js. There are a number of <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects">built-in objects</a> that are part of the JavaScript language itself, which are also globally accessible.</p> <h2>Class: Buffer<span><a class="mark" href="#globals_class_buffer" id="globals_class_buffer">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.1.103</span> </div><!-- type=global --> <ul> <li> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function" class="type"><Function></a></li> </ul> <p>Used to handle binary data. See the <a href="buffer.html">buffer section</a>.</p> <h2>__dirname<span><a class="mark" href="#globals_dirname" id="globals_dirname">#</a></span></h2> <p>This variable may appear to be global but is not. See <a href="modules.html#modules_dirname"><code>__dirname</code></a>.</p> <h2>__filename<span><a class="mark" href="#globals_filename" id="globals_filename">#</a></span></h2> <p>This variable may appear to be global but is not. See <a href="modules.html#modules_filename"><code>__filename</code></a>.</p> <h2>clearImmediate(immediateObject)<span><a class="mark" href="#globals_clearimmediate_immediateobject" id="globals_clearimmediate_immediateobject">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.9.1</span> </div><!--type=global--> <p><a href="timers.html#timers_clearimmediate_immediate"><code>clearImmediate</code></a> is described in the <a href="timers.html">timers</a> section.</p> <h2>clearInterval(intervalObject)<span><a class="mark" href="#globals_clearinterval_intervalobject" id="globals_clearinterval_intervalobject">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.0.1</span> </div><!--type=global--> <p><a href="timers.html#timers_clearinterval_timeout"><code>clearInterval</code></a> is described in the <a href="timers.html">timers</a> section.</p> <h2>clearTimeout(timeoutObject)<span><a class="mark" href="#globals_cleartimeout_timeoutobject" id="globals_cleartimeout_timeoutobject">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.0.1</span> </div><!--type=global--> <p><a href="timers.html#timers_cleartimeout_timeout"><code>clearTimeout</code></a> is described in the <a href="timers.html">timers</a> section.</p> <h2>console<span><a class="mark" href="#globals_console" id="globals_console">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.1.100</span> </div><!-- type=global --> <ul> <li> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> </ul> <p>Used to print to stdout and stderr. See the <a href="console.html"><code>console</code></a> section.</p> <h2>exports<span><a class="mark" href="#globals_exports" id="globals_exports">#</a></span></h2> <p>This variable may appear to be global but is not. See <a href="modules.html#modules_exports"><code>exports</code></a>.</p> <h2>global<span><a class="mark" href="#globals_global" id="globals_global">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.1.27</span> </div><!-- type=global --> <ul> <li> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a> The global namespace object.</li> </ul> <p>In browsers, the top-level scope is the global scope. This means that within the browser <code>var something</code> will define a new global variable. In Node.js this is different. The top-level scope is not the global scope; <code>var something</code> inside a Node.js module will be local to that module.</p> <h2>module<span><a class="mark" href="#globals_module" id="globals_module">#</a></span></h2> <p>This variable may appear to be global but is not. See <a href="modules.html#modules_module"><code>module</code></a>.</p> <h2>process<span><a class="mark" href="#globals_process" id="globals_process">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.1.7</span> </div><!-- type=global --> <ul> <li> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object" class="type"><Object></a></li> </ul> <p>The process object. See the <a href="process.html#process_process"><code>process</code> object</a> section.</p> <h2>require()<span><a class="mark" href="#globals_require" id="globals_require">#</a></span></h2> <p>This variable may appear to be global but is not. See <a href="modules.html#modules_require"><code>require()</code></a>.</p> <h2>setImmediate(callback[, ...args])<span><a class="mark" href="#globals_setimmediate_callback_args" id="globals_setimmediate_callback_args">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.9.1</span> </div><!-- type=global --> <p><a href="timers.html#timers_setimmediate_callback_args"><code>setImmediate</code></a> is described in the <a href="timers.html">timers</a> section.</p> <h2>setInterval(callback, delay[, ...args])<span><a class="mark" href="#globals_setinterval_callback_delay_args" id="globals_setinterval_callback_delay_args">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.0.1</span> </div><!-- type=global --> <p><a href="timers.html#timers_setinterval_callback_delay_args"><code>setInterval</code></a> is described in the <a href="timers.html">timers</a> section.</p> <h2>setTimeout(callback, delay[, ...args])<span><a class="mark" href="#globals_settimeout_callback_delay_args" id="globals_settimeout_callback_delay_args">#</a></span></h2> <div class="api_metadata"> <span>Added in: v0.0.1</span> </div><!-- type=global --> <p><a href="timers.html#timers_settimeout_callback_delay_args"><code>setTimeout</code></a> is described in the <a href="timers.html">timers</a> section.</p> </div> </div> </div> <script src="assets/sh_main.js"></script> <script src="assets/sh_javascript.min.js"></script> <script>highlight(undefined, undefined, 'pre');</script> <!-- __TRACKING__ --> </body> </html>