Browse Source

doc: add process api data types to documentation

PR-URL: https://github.com/nodejs/node/pull/9505
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
v6
imatvieiev 8 years ago
committed by Roman Reiss
parent
commit
c184f22997
No known key found for this signature in database GPG Key ID: 2E62B41C93869443
  1. 58
      doc/api/process.md

58
doc/api/process.md

@ -447,6 +447,8 @@ generate a core file.
added: v0.5.0 added: v0.5.0
--> -->
* {String}
The `process.arch` property returns a String identifying the processor The `process.arch` property returns a String identifying the processor
architecture that the Node.js process is currently running on. For instance architecture that the Node.js process is currently running on. For instance
`'arm'`, `'ia32'`, or `'x64'`. `'arm'`, `'ia32'`, or `'x64'`.
@ -460,6 +462,8 @@ console.log(`This processor architecture is ${process.arch}`);
added: v0.1.27 added: v0.1.27
--> -->
* {Array}
The `process.argv` property returns an array containing the command line The `process.argv` property returns an array containing the command line
arguments passed when the Node.js process was launched. The first element will arguments passed when the Node.js process was launched. The first element will
be [`process.execPath`]. See `process.argv0` if access to the original value of be [`process.execPath`]. See `process.argv0` if access to the original value of
@ -497,6 +501,8 @@ Would generate the output:
added: 6.4.0 added: 6.4.0
--> -->
* {String}
The `process.argv0` property stores a read-only copy of the original value of The `process.argv0` property stores a read-only copy of the original value of
`argv[0]` passed when Node.js starts. `argv[0]` passed when Node.js starts.
@ -545,6 +551,8 @@ catch (err) {
added: v0.7.7 added: v0.7.7
--> -->
* {Object}
The `process.config` property returns an Object containing the JavaScript The `process.config` property returns an Object containing the JavaScript
representation of the configure options used to compile the current Node.js representation of the configure options used to compile the current Node.js
executable. This is the same as the `config.gypi` file that was produced when executable. This is the same as the `config.gypi` file that was produced when
@ -588,6 +596,8 @@ replace the value of `process.config`.
added: v0.7.2 added: v0.7.2
--> -->
* {Boolean}
If the Node.js process is spawned with an IPC channel (see the [Child Process][] If the Node.js process is spawned with an IPC channel (see the [Child Process][]
and [Cluster][] documentation), the `process.connected` property will return and [Cluster][] documentation), the `process.connected` property will return
`true` so long as the IPC channel is connected and will return `false` after `true` so long as the IPC channel is connected and will return `false` after
@ -603,6 +613,9 @@ added: v6.1.0
* `previousValue` {Object} A previous return value from calling * `previousValue` {Object} A previous return value from calling
`process.cpuUsage()` `process.cpuUsage()`
* Return: {Object}
* `user` {Integer}
* `system` {Integer}
The `process.cpuUsage()` method returns the user and system CPU time usage of The `process.cpuUsage()` method returns the user and system CPU time usage of
the current process, in an object with properties `user` and `system`, whose the current process, in an object with properties `user` and `system`, whose
@ -630,6 +643,8 @@ console.log(process.cpuUsage(startUsage));
added: v0.1.8 added: v0.1.8
--> -->
* Return: {String}
The `process.cwd()` method returns the current working directory of the Node.js The `process.cwd()` method returns the current working directory of the Node.js
process. process.
@ -658,6 +673,8 @@ If the Node.js process was not spawned with an IPC channel,
added: v0.1.27 added: v0.1.27
--> -->
* {Object}
The `process.env` property returns an object containing the user environment. The `process.env` property returns an object containing the user environment.
See environ(7). See environ(7).
@ -822,6 +839,8 @@ emitMyWarning();
added: v0.7.7 added: v0.7.7
--> -->
* {Object}
The `process.execArgv` property returns the set of Node.js-specific command-line The `process.execArgv` property returns the set of Node.js-specific command-line
options passed when the Node.js process was launched. These options do not options passed when the Node.js process was launched. These options do not
appear in the array returned by the [`process.argv`][] property, and do not appear in the array returned by the [`process.argv`][] property, and do not
@ -852,13 +871,15 @@ And `process.argv`:
added: v0.1.100 added: v0.1.100
--> -->
* {String}
The `process.execPath` property returns the absolute pathname of the executable The `process.execPath` property returns the absolute pathname of the executable
that started the Node.js process. that started the Node.js process.
For example: For example:
```sh ```js
/usr/local/bin/node '/usr/local/bin/node'
``` ```
@ -931,6 +952,8 @@ is safer than calling `process.exit()`.
added: v0.11.8 added: v0.11.8
--> -->
* {Integer}
A number which will be the process exit code, when the process either A number which will be the process exit code, when the process either
exits gracefully, or is exited via [`process.exit()`][] without specifying exits gracefully, or is exited via [`process.exit()`][] without specifying
a code. a code.
@ -961,6 +984,8 @@ or Android)
added: v2.0.0 added: v2.0.0
--> -->
* Return: {Object}
The `process.geteuid()` method returns the numerical effective user identity of The `process.geteuid()` method returns the numerical effective user identity of
the process. (See geteuid(2).) the process. (See geteuid(2).)
@ -978,6 +1003,8 @@ Android)
added: v0.1.31 added: v0.1.31
--> -->
* Return: {Object}
The `process.getgid()` method returns the numerical group identity of the The `process.getgid()` method returns the numerical group identity of the
process. (See getgid(2).) process. (See getgid(2).)
@ -996,6 +1023,8 @@ Android)
added: v0.9.4 added: v0.9.4
--> -->
* Return: {Array}
The `process.getgroups()` method returns an array with the supplementary group The `process.getgroups()` method returns an array with the supplementary group
IDs. POSIX leaves it unspecified if the effective group ID is included but IDs. POSIX leaves it unspecified if the effective group ID is included but
Node.js ensures it always is. Node.js ensures it always is.
@ -1008,6 +1037,8 @@ Android)
added: v0.1.28 added: v0.1.28
--> -->
* Return: {Integer}
The `process.getuid()` method returns the numeric user identity of the process. The `process.getuid()` method returns the numeric user identity of the process.
(See getuid(2).) (See getuid(2).)
@ -1140,6 +1171,11 @@ is no entry script.
added: v0.1.16 added: v0.1.16
--> -->
* Return: {Object}
* `rss` {Integer}
* `heapTotal` {Integer}
* `heapUsed` {Integer}
The `process.memoryUsage()` method returns an object describing the memory usage The `process.memoryUsage()` method returns an object describing the memory usage
of the Node.js process measured in bytes. of the Node.js process measured in bytes.
@ -1259,6 +1295,8 @@ happening, just like a `while(true);` loop.
added: v0.1.15 added: v0.1.15
--> -->
* {Integer}
The `process.pid` property returns the PID of the process. The `process.pid` property returns the PID of the process.
```js ```js
@ -1270,6 +1308,8 @@ console.log(`This process is pid ${process.pid}`);
added: v0.1.16 added: v0.1.16
--> -->
* {String}
The `process.platform` property returns a string identifying the operating The `process.platform` property returns a string identifying the operating
system platform on which the Node.js process is running. For instance system platform on which the Node.js process is running. For instance
`'darwin'`, `'freebsd'`, `'linux'`, `'sunos'` or `'win32'` `'darwin'`, `'freebsd'`, `'linux'`, `'sunos'` or `'win32'`
@ -1471,6 +1511,8 @@ Android)
## process.stderr ## process.stderr
* {Stream}
The `process.stderr` property returns a [Writable][] stream equivalent to or The `process.stderr` property returns a [Writable][] stream equivalent to or
associated with `stderr` (fd `2`). associated with `stderr` (fd `2`).
@ -1491,6 +1533,8 @@ on `process.stderr`, `process.stdout`, or `process.stdin`:
## process.stdin ## process.stdin
* {Stream}
The `process.stdin` property returns a [Readable][] stream equivalent to or The `process.stdin` property returns a [Readable][] stream equivalent to or
associated with `stdin` (fd `0`). associated with `stdin` (fd `0`).
@ -1521,6 +1565,8 @@ must call `process.stdin.resume()` to read from it. Note also that calling
## process.stdout ## process.stdout
* {Stream}
The `process.stdout` property returns a [Writable][] stream equivalent to or The `process.stdout` property returns a [Writable][] stream equivalent to or
associated with `stdout` (fd `1`). associated with `stdout` (fd `1`).
@ -1576,6 +1622,8 @@ See the [TTY][] documentation for more information.
added: v0.1.104 added: v0.1.104
--> -->
* {String}
The `process.title` property returns the current process title (i.e. returns The `process.title` property returns the current process title (i.e. returns
the current value of `ps`). Assigning a new value to `process.title` modifies the current value of `ps`). Assigning a new value to `process.title` modifies
the current value of `ps`. the current value of `ps`.
@ -1615,6 +1663,8 @@ console.log(
added: v0.5.0 added: v0.5.0
--> -->
* Return: {Number}
The `process.uptime()` method returns the number of seconds the current Node.js The `process.uptime()` method returns the number of seconds the current Node.js
process has been running. process has been running.
@ -1623,6 +1673,8 @@ process has been running.
added: v0.1.3 added: v0.1.3
--> -->
* {String}
The `process.version` property returns the Node.js version string. The `process.version` property returns the Node.js version string.
```js ```js
@ -1634,6 +1686,8 @@ console.log(`Version: ${process.version}`);
added: v0.2.0 added: v0.2.0
--> -->
* {Object}
The `process.versions` property returns an object listing the version strings of The `process.versions` property returns an object listing the version strings of
Node.js and its dependencies. Node.js and its dependencies.

Loading…
Cancel
Save