Browse Source

doc refactor: process

v0.8.7-release
isaacs 13 years ago
parent
commit
e083720d54
  1. 67
      doc/api/process.markdown

67
doc/api/process.markdown

@ -1,12 +1,12 @@
## process # process
<!-- type=global -->
The `process` object is a global object and can be accessed from anywhere. The `process` object is a global object and can be accessed from anywhere.
It is an instance of `EventEmitter`. It is an instance of `EventEmitter`.
### Event: 'exit' ## Event: 'exit'
`function () {}`
Emitted when the process is about to exit. This is a good hook to perform Emitted when the process is about to exit. This is a good hook to perform
constant time checks of the module's state (like for unit tests). The main constant time checks of the module's state (like for unit tests). The main
@ -22,9 +22,7 @@ Example of listening for `exit`:
console.log('About to exit.'); console.log('About to exit.');
}); });
### Event: 'uncaughtException' ## Event: 'uncaughtException'
`function (err) { }`
Emitted when an exception bubbles all the way back to the event loop. If a Emitted when an exception bubbles all the way back to the event loop. If a
listener is added for this exception, the default action (which is to print listener is added for this exception, the default action (which is to print
@ -50,9 +48,10 @@ your program's flow. Especially for server programs that are designed to
stay running forever, `uncaughtException` can be a useful safety mechanism. stay running forever, `uncaughtException` can be a useful safety mechanism.
### Signal Events ## Signal Events
`function () {}` <!--type=event-->
<!--name=SIGINT, SIGUSR1, etc.-->
Emitted when the processes receives a signal. See sigaction(2) for a list of Emitted when the processes receives a signal. See sigaction(2) for a list of
standard POSIX signal names such as SIGINT, SIGUSR1, etc. standard POSIX signal names such as SIGINT, SIGUSR1, etc.
@ -70,7 +69,7 @@ An easy way to send the `SIGINT` signal is with `Control-C` in most terminal
programs. programs.
### process.stdout ## process.stdout
A `Writable Stream` to `stdout`. A `Writable Stream` to `stdout`.
@ -86,7 +85,7 @@ that they refer to regular files or TTY file descriptors. In the case they
refer to pipes, they are non-blocking like other streams. refer to pipes, they are non-blocking like other streams.
### process.stderr ## process.stderr
A writable stream to stderr. A writable stream to stderr.
@ -96,7 +95,7 @@ that they refer to regular files or TTY file descriptors. In the case they
refer to pipes, they are non-blocking like other streams. refer to pipes, they are non-blocking like other streams.
### process.stdin ## process.stdin
A `Readable Stream` for stdin. The stdin stream is paused by default, so one A `Readable Stream` for stdin. The stdin stream is paused by default, so one
must call `process.stdin.resume()` to read from it. must call `process.stdin.resume()` to read from it.
@ -115,7 +114,7 @@ Example of opening standard input and listening for both events:
}); });
### process.argv ## process.argv
An array containing the command line arguments. The first element will be An array containing the command line arguments. The first element will be
'node', the second element will be the name of the JavaScript file. The 'node', the second element will be the name of the JavaScript file. The
@ -136,7 +135,7 @@ This will generate:
4: four 4: four
### process.execPath ## process.execPath
This is the absolute pathname of the executable that started the process. This is the absolute pathname of the executable that started the process.
@ -145,7 +144,7 @@ Example:
/usr/local/bin/node /usr/local/bin/node
### process.chdir(directory) ## process.chdir(directory)
Changes the current working directory of the process or throws an exception if that fails. Changes the current working directory of the process or throws an exception if that fails.
@ -160,19 +159,19 @@ Changes the current working directory of the process or throws an exception if t
### process.cwd() ## process.cwd()
Returns the current working directory of the process. Returns the current working directory of the process.
console.log('Current directory: ' + process.cwd()); console.log('Current directory: ' + process.cwd());
### process.env ## process.env
An object containing the user environment. See environ(7). An object containing the user environment. See environ(7).
### process.exit([code]) ## process.exit([code])
Ends the process with the specified `code`. If omitted, exit uses the Ends the process with the specified `code`. If omitted, exit uses the
'success' code `0`. 'success' code `0`.
@ -184,7 +183,7 @@ To exit with a 'failure' code:
The shell that executed node should see the exit code as 1. The shell that executed node should see the exit code as 1.
### process.getgid() ## process.getgid()
Gets the group identity of the process. (See getgid(2).) Gets the group identity of the process. (See getgid(2).)
This is the numerical group id, not the group name. This is the numerical group id, not the group name.
@ -192,7 +191,7 @@ This is the numerical group id, not the group name.
console.log('Current gid: ' + process.getgid()); console.log('Current gid: ' + process.getgid());
### process.setgid(id) ## process.setgid(id)
Sets the group identity of the process. (See setgid(2).) This accepts either Sets the group identity of the process. (See setgid(2).) This accepts either
a numerical ID or a groupname string. If a groupname is specified, this method a numerical ID or a groupname string. If a groupname is specified, this method
@ -208,7 +207,7 @@ blocks while resolving it to a numerical ID.
} }
### process.getuid() ## process.getuid()
Gets the user identity of the process. (See getuid(2).) Gets the user identity of the process. (See getuid(2).)
This is the numerical userid, not the username. This is the numerical userid, not the username.
@ -216,7 +215,7 @@ This is the numerical userid, not the username.
console.log('Current uid: ' + process.getuid()); console.log('Current uid: ' + process.getuid());
### process.setuid(id) ## process.setuid(id)
Sets the user identity of the process. (See setuid(2).) This accepts either Sets the user identity of the process. (See setuid(2).) This accepts either
a numerical ID or a username string. If a username is specified, this method a numerical ID or a username string. If a username is specified, this method
@ -232,13 +231,13 @@ blocks while resolving it to a numerical ID.
} }
### process.version ## process.version
A compiled-in property that exposes `NODE_VERSION`. A compiled-in property that exposes `NODE_VERSION`.
console.log('Version: ' + process.version); console.log('Version: ' + process.version);
### process.versions ## process.versions
A property exposing version strings of node and its dependencies. A property exposing version strings of node and its dependencies.
@ -253,14 +252,14 @@ Will output:
openssl: '1.0.0e-fips' } openssl: '1.0.0e-fips' }
### process.installPrefix ## process.installPrefix
A compiled-in property that exposes `NODE_PREFIX`. A compiled-in property that exposes `NODE_PREFIX`.
console.log('Prefix: ' + process.installPrefix); console.log('Prefix: ' + process.installPrefix);
### process.kill(pid, [signal]) ## process.kill(pid, [signal])
Send a signal to a process. `pid` is the process id and `signal` is the Send a signal to a process. `pid` is the process id and `signal` is the
string describing the signal to send. Signal names are strings like string describing the signal to send. Signal names are strings like
@ -285,32 +284,32 @@ Example of sending a signal to yourself:
process.kill(process.pid, 'SIGHUP'); process.kill(process.pid, 'SIGHUP');
### process.pid ## process.pid
The PID of the process. The PID of the process.
console.log('This process is pid ' + process.pid); console.log('This process is pid ' + process.pid);
### process.title ## process.title
Getter/setter to set what is displayed in 'ps'. Getter/setter to set what is displayed in 'ps'.
### process.arch ## process.arch
What processor architecture you're running on: `'arm'`, `'ia32'`, or `'x64'`. What processor architecture you're running on: `'arm'`, `'ia32'`, or `'x64'`.
console.log('This processor architecture is ' + process.arch); console.log('This processor architecture is ' + process.arch);
### process.platform ## process.platform
What platform you're running on. `'linux2'`, `'darwin'`, etc. What platform you're running on. `'linux2'`, `'darwin'`, etc.
console.log('This platform is ' + process.platform); console.log('This platform is ' + process.platform);
### process.memoryUsage() ## process.memoryUsage()
Returns an object describing the memory usage of the Node process Returns an object describing the memory usage of the Node process
measured in bytes. measured in bytes.
@ -328,7 +327,7 @@ This will generate:
`heapTotal` and `heapUsed` refer to V8's memory usage. `heapTotal` and `heapUsed` refer to V8's memory usage.
### process.nextTick(callback) ## process.nextTick(callback)
On the next loop around the event loop call this callback. On the next loop around the event loop call this callback.
This is *not* a simple alias to `setTimeout(fn, 0)`, it's much more This is *not* a simple alias to `setTimeout(fn, 0)`, it's much more
@ -339,7 +338,7 @@ efficient.
}); });
### process.umask([mask]) ## process.umask([mask])
Sets or reads the process's file mode creation mask. Child processes inherit Sets or reads the process's file mode creation mask. Child processes inherit
the mask from the parent process. Returns the old mask if `mask` argument is the mask from the parent process. Returns the old mask if `mask` argument is
@ -352,6 +351,6 @@ given, otherwise returns the current mask.
' to ' + newmask.toString(8)); ' to ' + newmask.toString(8));
### process.uptime() ## process.uptime()
Number of seconds Node has been running. Number of seconds Node has been running.

Loading…
Cancel
Save