Skip to content

Commit

Permalink
doc: add added: information for globals
Browse files Browse the repository at this point in the history
Ref: #6578
PR-URL: #8901
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
lpinca authored and addaleax committed Oct 6, 2016
1 parent eff6205 commit bd0bedb
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions doc/api/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ The objects listed here are specific to Node.js. There are a number of
also globally accessible.

## Class: Buffer
<!-- YAML
added: v0.1.103
-->

<!-- type=global -->

Expand All @@ -18,6 +21,9 @@ also globally accessible.
Used to handle binary data. See the [buffer section][].

## \_\_dirname
<!-- YAML
added: v0.1.27
-->

<!-- type=var -->

Expand Down Expand Up @@ -45,6 +51,9 @@ References to `__dirname` within `b.js` will return
will return `/Users/mjr/app`.

## \_\_filename
<!-- YAML
added: v0.0.1
-->

<!-- type=var -->

Expand All @@ -65,24 +74,36 @@ console.log(__filename);
`__filename` isn't actually a global but rather local to each module.

## clearImmediate(immediateObject)
<!-- YAML
added: v0.9.1
-->

<!--type=global-->

[`clearImmediate`] is described in the [timers][] section.

## clearInterval(intervalObject)
<!-- YAML
added: v0.0.1
-->

<!--type=global-->

[`clearInterval`] is described in the [timers][] section.

## clearTimeout(timeoutObject)
<!-- YAML
added: v0.0.1
-->

<!--type=global-->

[`clearTimeout`] is described in the [timers][] section.

## console
<!-- YAML
added: v0.1.100
-->

<!-- type=global -->

Expand All @@ -91,6 +112,9 @@ console.log(__filename);
Used to print to stdout and stderr. See the [`console`][] section.

## exports
<!-- YAML
added: v0.1.12
-->

<!-- type=var -->

Expand All @@ -103,6 +127,9 @@ when to use `module.exports`.
See the [module system documentation][] for more information.

## global
<!-- YAML
added: v0.1.27
-->

<!-- type=global -->

Expand All @@ -114,6 +141,9 @@ 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
<!-- YAML
added: v0.1.16
-->

<!-- type=var -->

Expand All @@ -128,6 +158,9 @@ available through `require()`.
See the [module system documentation][] for more information.

## process
<!-- YAML
added: v0.1.7
-->

<!-- type=global -->

Expand All @@ -136,6 +169,9 @@ See the [module system documentation][] for more information.
The process object. See the [`process` object][] section.

## require()
<!-- YAML
added: v0.1.13
-->

<!-- type=var -->

Expand All @@ -145,6 +181,9 @@ To require modules. See the [Modules][] section. `require` isn't actually a
global but rather local to each module.

### require.cache
<!-- YAML
added: v0.3.0
-->

* {Object}

Expand All @@ -154,6 +193,10 @@ this does not apply to [native addons][], for which reloading will result in an
Error.

### require.extensions
<!-- YAML
added: v0.3.0
deprecated: v0.10.6
-->

> Stability: 0 - Deprecated
Expand All @@ -178,23 +221,35 @@ away. However, it may have subtle bugs and complexities that are best
left untouched.

### require.resolve()
<!-- YAML
added: v0.3.0
-->

Use the internal `require()` machinery to look up the location of a module,
but rather than loading the module, just return the resolved filename.

## setImmediate(callback[, ...args])
<!-- YAML
added: v0.9.1
-->

<!-- type=global -->

[`setImmediate`] is described in the [timers][] section.

## setInterval(callback, delay[, ...args])
<!-- YAML
added: v0.0.1
-->

<!-- type=global -->

[`setInterval`] is described in the [timers][] section.

## setTimeout(callback, delay[, ...args])
<!-- YAML
added: v0.0.1
-->

<!-- type=global -->

Expand Down

0 comments on commit bd0bedb

Please sign in to comment.