doc/api/globals.markdown

   1 # Global Objects
   2
   3 <!-- type=misc -->
   4
   5 These objects are available in all modules. Some of these objects aren't
   6 actually in the global scope but in the module scope - this will be noted.
   7
   8 ## global
   9
  10 <!-- type=global -->
  11
  12 * {Object} The global namespace object.
  13
  14 In browsers, the top-level scope is the global scope. That means that in
  15 browsers if you're in the global scope `var something` will define a global
  16 variable. In Node this is different. The top-level scope is not the global
  17 scope; `var something` inside a Node module will be local to that module.
  18
  19 ## process
  20
  21 <!-- type=global -->
  22
  23 * {Object}
  24
  25 The process object. See the [process object][] section.
  26
  27 ## console
  28
  29 <!-- type=global -->
  30
  31 * {Object}
  32
  33 Used to print to stdout and stderr. See the [stdio][] section.
  34
  35 ## Class: Buffer
  36
  37 <!-- type=global -->
  38
  39 * {Function}
  40
  41 Used to handle binary data. See the [buffer section][]
  42
  43 ## require()
  44
  45 <!-- type=var -->
  46
  47 * {Function}
  48
  49 To require modules. See the [Modules][] section.  `require` isn't actually a
  50 global but rather local to each module.
  51
  52 ### require.resolve()
  53
  54 Use the internal `require()` machinery to look up the location of a module,
  55 but rather than loading the module, just return the resolved filename.
  56
  57 ### require.cache
  58
  59 * {Object}
  60
  61 Modules are cached in this object when they are required. By deleting a key
  62 value from this object, the next `require` will reload the module.
  63
  64 ### require.extensions
  65
  66 * {Array}
  67
  68 Instruct `require` on how to handle certain file extensions.
  69
  70 Process files with the extension `.sjs` as `.js`:
  71
  72     require.extensions['.sjs'] = require.extensions['.js'];
  73
  74 ## __filename
  75
  76 <!-- type=var -->
  77
  78 * {String}
  79
  80 The filename of the code being executed.  This is the resolved absolute path
  81 of this code file.  For a main program this is not necessarily the same
  82 filename used in the command line.  The value inside a module is the path
  83 to that module file.
  84
  85 Example: running `node example.js` from `/Users/mjr`
  86
  87     console.log(__filename);
  88     // /Users/mjr/example.js
  89
  90 `__filename` isn't actually a global but rather local to each module.
  91
  92 ## __dirname
  93
  94 <!-- type=var -->
  95
  96 * {String}
  97
  98 The name of the directory that the currently executing script resides in.
  99
 100 Example: running `node example.js` from `/Users/mjr`
 101
 102     console.log(__dirname);
 103     // /Users/mjr
 104
 105 `__dirname` isn't actually a global but rather local to each module.
 106
 107
 108 ## module
 109
 110 <!-- type=var -->
 111
 112 * {Object}
 113
 114 A reference to the current module. In particular
 115 `module.exports` is the same as the `exports` object.
 116 `module` isn't actually a global but rather local to each module.
 117
 118 See the [module system documentation][] for more information.
 119
 120 ## exports
 121
 122 <!-- type=var -->
 123
 124 An object which is shared between all instances of the current module and
 125 made accessible through `require()`.
 126 `exports` is the same as the `module.exports` object.
 127 `exports` isn't actually a global but rather local to each module.
 128
 129 See the [module system documentation][] for more information.
 130
 131 See the [module section][] for more information.
 132
 133 ## setTimeout(cb, ms)
 134
 135 Run callback `cb` after *at least* `ms` milliseconds. The actual delay depends
 136 on external factors like OS timer granularity and system load.
 137
 138 The timeout must be in the range of 1-2,147,483,647 inclusive. If the value is
 139 outside that range, it's changed to 1 millisecond. Broadly speaking, a timer
 140 cannot span more than 24.8 days.
 141
 142 Returns an opaque value that represents the timer.
 143
 144 ## clearTimeout(t)
 145
 146 Stop a timer that was previously created with `setTimeout()`. The callback will
 147 not execute.
 148
 149 ## setInterval(cb, ms)
 150
 151 Run callback `cb` repeatedly every `ms` milliseconds. Note that the actual
 152 interval may vary, depending on external factors like OS timer granularity and
 153 system load. It's never less than `ms` but it may be longer.
 154
 155 The interval must be in the range of 1-2,147,483,647 inclusive. If the value is
 156 outside that range, it's changed to 1 millisecond. Broadly speaking, a timer
 157 cannot span more than 24.8 days.
 158
 159 Returns an opaque value that represents the timer.
 160
 161 ## clearInterval(t)
 162
 163 Stop a timer that was previously created with `setInterval()`. The callback
 164 will not execute.
 165
 166 <!--type=global-->
 167
 168 The timer functions are global variables. See the [timers][] section.
 169
 170 [buffer section]: buffer.html
 171 [module section]: modules.html
 172 [module system documentation]: modules.html
 173 [Modules]: modules.html#modules_modules
 174 [process object]: process.html#process_process
 175 [stdio]: stdio.html
 176 [timers]: timers.html