doc/api/globals.markdown

   1 ## Global Objects
   2
   3 These object are available in all modules. Some of these objects aren't
   4 actually in the global scope but in the module scope - this will be noted.
   5
   6 ### global
   7
   8 The global namespace object.
   9
  10 In browsers, the top-level scope is the global scope. That means that in
  11 browsers if you're in the global scope `var something` will define a global
  12 variable. In Node this is different. The top-level scope is not the global
  13 scope; `var something` inside a Node module will be local to that module.
  14
  15 ### process
  16
  17 The process object. See the [process object](process.html#process) section.
  18
  19 ### require()
  20
  21 To require modules. See the [Modules](modules.html#modules) section.
  22 `require` isn't actually a global but rather local to each module.
  23
  24
  25 ### require.resolve()
  26
  27 Use the internal `require()` machinery to look up the location of a module,
  28 but rather than loading the module, just return the resolved filename.
  29
  30 ### require.paths
  31
  32 An array of search paths for `require()`.  This array can be modified to add
  33 custom paths.
  34
  35 Example: add a new path to the beginning of the search list
  36
  37     require.paths.unshift('/usr/local/node');
  38
  39
  40 ### __filename
  41
  42 The filename of the script being executed.  This is the absolute path, and not necessarily
  43 the same filename passed in as a command line argument.
  44
  45 Example: running `node example.js` from `/Users/mjr`
  46
  47     console.log(__filename);
  48     // /Users/mjr/example.js
  49
  50 `__filename` isn't actually a global but rather local to each module.
  51
  52 ### __dirname
  53
  54 The dirname of the script being executed.
  55
  56 Example: running `node example.js` from `/Users/mjr`
  57
  58     console.log(__dirname);
  59     // /Users/mjr
  60
  61 `__dirname` isn't actually a global but rather local to each module.
  62
  63
  64 ### module
  65
  66 A reference to the current module. In particular
  67 `module.exports` is the same as the `exports` object. See `src/node.js`
  68 for more information.
  69 `module` isn't actually a global but rather local to each module.
  70
  71 ### setTimeout(cb, ms)
  72 ### clearTimeout(t)
  73 ### setInterval(cb, ms)
  74 ### clearInterval(t)
  75
  76 The timer functions are global variables. See the [timers](timers.html) section.