Browse Source

doc refactor: process

v0.9.1-release
isaacs 13 years ago
parent
commit
a52254d0d7
  1. 65
      doc/api/process.markdown

65
doc/api/process.markdown

@ -1,10 +1,12 @@
## process
# process
<!-- type=global -->
The `process` object is a global object and can be accessed from anywhere.
It is an instance of `EventEmitter`.
### Event: 'exit'
## Event: 'exit'
`function () {}`
@ -22,7 +24,7 @@ Example of listening for `exit`:
console.log('About to exit.');
});
### Event: 'uncaughtException'
## Event: 'uncaughtException'
`function (err) { }`
@ -50,7 +52,10 @@ your program's flow. Especially for server programs that are designed to
stay running forever, `uncaughtException` can be a useful safety mechanism.
### Signal Events
## Signal Events
<!--type=event-->
<!--name=SIGINT, SIGUSR1, etc.-->
`function () {}`
@ -70,7 +75,7 @@ An easy way to send the `SIGINT` signal is with `Control-C` in most terminal
programs.
### process.stdout
## process.stdout
A `Writable Stream` to `stdout`.
@ -86,7 +91,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.
### process.stderr
## process.stderr
A writable stream to stderr.
@ -96,7 +101,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.
### process.stdin
## process.stdin
A `Readable Stream` for stdin. The stdin stream is paused by default, so one
must call `process.stdin.resume()` to read from it.
@ -115,7 +120,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
'node', the second element will be the name of the JavaScript file. The
@ -136,7 +141,7 @@ This will generate:
4: four
### process.execPath
## process.execPath
This is the absolute pathname of the executable that started the process.
@ -145,12 +150,12 @@ Example:
/usr/local/bin/node
### process.abort()
## process.abort()
This causes node to emit an abort. This will cause node to exit and
generate a core file.
### process.chdir(directory)
## process.chdir(directory)
Changes the current working directory of the process or throws an exception if that fails.
@ -165,19 +170,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.
console.log('Current directory: ' + process.cwd());
### process.env
## process.env
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
'success' code `0`.
@ -189,7 +194,7 @@ To exit with a 'failure' code:
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).)
This is the numerical group id, not the group name.
@ -197,7 +202,7 @@ This is the numerical group id, not the group name.
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
a numerical ID or a groupname string. If a groupname is specified, this method
@ -213,7 +218,7 @@ blocks while resolving it to a numerical ID.
}
### process.getuid()
## process.getuid()
Gets the user identity of the process. (See getuid(2).)
This is the numerical userid, not the username.
@ -221,7 +226,7 @@ This is the numerical userid, not the username.
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
a numerical ID or a username string. If a username is specified, this method
@ -237,13 +242,13 @@ blocks while resolving it to a numerical ID.
}
### process.version
## process.version
A compiled-in property that exposes `NODE_VERSION`.
console.log('Version: ' + process.version);
### process.versions
## process.versions
A property exposing version strings of node and its dependencies.
@ -258,14 +263,14 @@ Will output:
openssl: '1.0.0e-fips' }
### process.installPrefix
## process.installPrefix
A compiled-in property that exposes `NODE_PREFIX`.
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
string describing the signal to send. Signal names are strings like
@ -290,32 +295,32 @@ Example of sending a signal to yourself:
process.kill(process.pid, 'SIGHUP');
### process.pid
## process.pid
The PID of the process.
console.log('This process is pid ' + process.pid);
### process.title
## process.title
Getter/setter to set what is displayed in 'ps'.
### process.arch
## process.arch
What processor architecture you're running on: `'arm'`, `'ia32'`, or `'x64'`.
console.log('This processor architecture is ' + process.arch);
### process.platform
## process.platform
What platform you're running on. `'linux2'`, `'darwin'`, etc.
console.log('This platform is ' + process.platform);
### process.memoryUsage()
## process.memoryUsage()
Returns an object describing the memory usage of the Node process
measured in bytes.
@ -333,7 +338,7 @@ This will generate:
`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.
This is *not* a simple alias to `setTimeout(fn, 0)`, it's much more
@ -344,7 +349,7 @@ efficient.
});
### process.umask([mask])
## process.umask([mask])
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
@ -357,6 +362,6 @@ given, otherwise returns the current mask.
' to ' + newmask.toString(8));
### process.uptime()
## process.uptime()
Number of seconds Node has been running.

Loading…
Cancel
Save