process
Related Doc:
package nodejs
This causes Node.js to emit an abort.
This causes Node.js to emit an abort. This will cause Node.js to exit and generate a core file.
process.abort()
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
emitter.addListener(eventName, listener)
on()
What processor architecture you're running on: 'arm', 'ia32', or 'x64'.
What processor architecture you're running on: 'arm', 'ia32', or 'x64'.
process.arch
An array containing the command line arguments.
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 next elements will be any additional command line arguments.
process.argv
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.
process.chdir(directory)
An Object containing the JavaScript representation of the configure options that were used to compile the current Node.js executable.
An Object containing the JavaScript representation of the configure options that were used to compile the current Node.js executable.
If process.connected is false, it is no longer possible to send messages
If process.connected is false, it is no longer possible to send messages
process.connected
Returns the current working directory of the process.
Returns the current working directory of the process.
process.cwd()
Returns the debug port
Returns the debug port
Close the IPC channel to the parent process, allowing this child to exit gracefully once there are no other connections keeping it alive.
Close the IPC channel to the parent process, allowing this child to exit gracefully once there are no other connections keeping it alive.
Identical to the parent process's ChildProcess.disconnect(). If Node.js was not spawned with an IPC channel, process.disconnect() will be undefined.
process.disconnect()
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Returns true if the event had listeners, false otherwise.
the event name
the event arguments
emitter.emit(name[, arg1][, arg2][, ...])
The process.emitWarning() method can be used to emit custom or application specific process warnings.
The process.emitWarning() method can be used to emit custom or application specific process warnings. These can be listened for by adding a handler to the process.on('warning') event.
The warning to emit (String | Error)
When warning is a String, name is the name to use for the warning. Default: Warning.
When warning is a String, ctor is an optional function used to limit the generated stack trace. Default process.emitWarning
process.emitWarning(warning[, name][, ctor])
An object containing the user environment.
An object containing the user environment.
This is the set of Node.js-specific command line options from the executable that started the process.
This is the set of Node.js-specific command line options from the executable that started the process. These options do not show up in process.argv, and do not include the Node.js executable, the name of the script, or any options following the script name. These options are useful in order to spawn child processes with the same execution environment as the parent.
0.7.7
This is the absolute pathname of the executable that started the process.
This is the absolute pathname of the executable that started the process.
process.execPath
Ends the process with the specified code.
Ends the process with the specified code. If omitted, exit uses the 'success' code 0.
process.exit([code])
A number which will be the process exit code, when the process either exits gracefully, or is exited via process.exit() without specifying a code.
A number which will be the process exit code, when the process either exits gracefully, or is exited via process.exit() without specifying a code.
Specifying a code to process.exit(code) will override any previous setting of process.exitCode.
process.exitCode
TODO find documentation for this property
TODO find documentation for this property
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
emitter.getMaxListeners()
setMaxListeners()
Gets the effective group identity of the process.
Gets the effective group identity of the process. This is the numerical group id, not the group name.
Note: this function is only available on POSIX platforms (i.e. not Windows, Android)
process.getegid()
Gets the effective user identity of the process.
Gets the effective user identity of the process. This is the numerical userid, not the username.
Note: this function is only available on POSIX platforms (i.e. not Windows, Android)
process.geteuid()
Gets the group identity of the process.
Gets the group identity of the process. This is the numerical group id, not the group name.
Note: this function is only available on POSIX platforms (i.e. not Windows, Android)
process.getgid()
Returns an array with the supplementary group IDs.
Returns an array with the supplementary group IDs. POSIX leaves it unspecified if the effective group ID is included but Node.js ensures it always is.
process.getgroups()
Gets the user identity of the process.
Gets the user identity of the process. (See getuid(2).) This is the numerical userid, not the username.
Note: this function is only available on POSIX platforms (i.e. not Windows, Android)
process.getuid()
Returns the current high-resolution real time in a [seconds, nanoseconds] tuple Array.
Returns the current high-resolution real time in a [seconds, nanoseconds] tuple Array. It is relative to an arbitrary time in the past. It is not related to the time of day and therefore not subject to clock drift. The primary use is for measuring performance between intervals.
process.hrtime([time])
Reads /etc/group and initializes the group access list, using all groups of which the user is a member.
Reads /etc/group and initializes the group access list, using all groups of which the user is a member. This is a privileged operation, meaning you need to be root or have the CAP_SETGID capability.
process.initgroups(user, extra_group)
Send a signal to a process.
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 SIGINT or SIGHUP. If omitted, the signal will be SIGTERM. See Signal Events and kill(2) for more information.
Will throw an error if target does not exist, and as a special case, a signal of 0 can be used to test for the existence of a process. Windows platforms will throw an error if the pid is used to kill a process group.
Note that even though the name of this function is process.kill, it is really just a signal sender, like the kill system call. The signal sent may do something other than kill the target process.
process.kill(pid[, signal])
Returns the number of listeners listening to the event named eventName.
Returns the number of listeners listening to the event named eventName.
emitter.listenerCount(eventName)
Returns a copy of the array of listeners for the event named eventName.
Returns a copy of the array of listeners for the event named eventName.
emitter.listeners(eventName)
Alternate way to retrieve require.main.
Alternate way to retrieve require.main. The difference is that if the main module changes at runtime, require.main might still refer to the original main module in modules that were required before the change occurred. Generally it's safe to assume that the two refer to the same module.
As with require.main, it will be undefined if there was no entry script.
Returns an object describing the memory usage of the Node.js process measured in bytes.
Returns an object describing the memory usage of the Node.js process measured in bytes.
process.memoryUsage()
Returns the loaded module list
Returns the loaded module list
Once the current event loop turn runs to completion, call the callback function.
Once the current event loop turn runs to completion, call the callback function.
This is not a simple alias to setTimeout(fn, 0), it's much more efficient. It runs before any additional I/O events (including timers) fire in subsequent ticks of the event loop.
process.nextTick(callback[, arg][, ...])
Adds the listener function to the end of the listeners array for the event named eventName.
Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
Returns a reference to the EventEmitter so calls can be chained.
emitter.on(eventName, listener)
Adds a one time listener function for the event named eventName.
Adds a one time listener function for the event named eventName. This listener is invoked only the next time eventName is triggered, after which it is removed.
emitter.once(eventName, listener)
TODO find documentation
TODO find documentation
The PID of the process.
The PID of the process.
process.pid
What platform you're running on: 'darwin', 'freebsd', 'linux', 'sunos' or 'win32'
What platform you're running on: 'darwin', 'freebsd', 'linux', 'sunos' or 'win32'
An Object containing metadata related to the current release, including URLs for the source tarball and headers-only tarball.
An Object containing metadata related to the current release, including URLs for the source tarball and headers-only tarball.
3.0.0
Removes all listeners, or those of the specified eventName.
Removes all listeners, or those of the specified eventName.
Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter so calls can be chained.
emitter.removeAllListeners([eventName])
Removes all listeners, or those of the specified eventName.
Removes all listeners, or those of the specified eventName.
Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter so calls can be chained.
emitter.removeAllListeners([eventName])
Removes the specified listener from the listener array for the event named eventName.
Removes the specified listener from the listener array for the event named eventName. removeListener will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener must be called multiple times to remove each instance.
Note that once an event has been emitted, all listeners attached to it at the time of emitting will be called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events will behave as expected.
emitter.removeListener(eventName, listener)
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send().
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send(). Each will be received as a 'message' event on the parent's ChildProcess object.
Note: this function uses JSON.stringify() internally to serialize the message. If Node.js was not spawned with an IPC channel, process.send() will be undefined.
process.send(message[, sendHandle[, options]][, callback])
0.5.9
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send().
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send(). Each will be received as a 'message' event on the parent's ChildProcess object.
Note: this function uses JSON.stringify() internally to serialize the message. If Node.js was not spawned with an IPC channel, process.send() will be undefined.
process.send(message[, sendHandle[, options]][, callback])
0.5.9
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send().
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send(). Each will be received as a 'message' event on the parent's ChildProcess object.
Note: this function uses JSON.stringify() internally to serialize the message. If Node.js was not spawned with an IPC channel, process.send() will be undefined.
process.send(message[, sendHandle[, options]][, callback])
0.5.9
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send().
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send(). Each will be received as a 'message' event on the parent's ChildProcess object.
Note: this function uses JSON.stringify() internally to serialize the message. If Node.js was not spawned with an IPC channel, process.send() will be undefined.
process.send(message[, sendHandle[, options]][, callback])
0.5.9
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send().
When Node.js is spawned with an IPC channel attached, it can send messages to its parent process using process.send(). Each will be received as a 'message' event on the parent's ChildProcess object.
Note: this function uses JSON.stringify() internally to serialize the message. If Node.js was not spawned with an IPC channel, process.send() will be undefined.
process.send(message[, sendHandle[, options]][, callback])
0.5.9
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event.
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. Obviously, not all events should be limited to just 10 listeners. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) for to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter so calls can be chained.
emitter.setMaxListeners(n)
Sets the effective group identity of the process.
Sets the effective group identity of the process. This accepts either a numerical ID or a groupname string. If a groupname is specified, this method blocks while resolving it to a numerical ID.
process.setegid(id)
2.0.0
Sets the effective user identity of the process.
Sets the effective user identity of the process. This accepts either a numerical ID or a username string. If a username is specified, this method blocks while resolving it to a numerical ID.
process.seteuid(id)
Sets the group identity of the process.
Sets the group identity of the process. This accepts either a numerical ID or a groupname string. If a groupname is specified, this method blocks while resolving it to a numerical ID.
process.setgid(id)
Sets the supplementary group IDs.
Sets the supplementary group IDs. This is a privileged operation, meaning you need to be root or have the CAP_SETGID capability. The list can contain group IDs, group names or both.
process.setgroups(groups)
Sets the user identity of the process.
Sets the user identity of the process. This accepts either a numerical ID or a username string. If a username is specified, this method blocks while resolving it to a numerical ID.
process.setuid(id)
process.stderr and process.stdout are unlike other streams in Node.js in that they cannot be closed (end() will throw), they never emit the finish event and that writes can block when output is redirected to a file (although disks are fast and operating systems normally employ write-back caching so it should be a very rare occurrence indeed.)
process.stderr and process.stdout are unlike other streams in Node.js in that they cannot be closed (end() will throw), they never emit the finish event and that writes can block when output is redirected to a file (although disks are fast and operating systems normally employ write-back caching so it should be a very rare occurrence indeed.)
A Readable Stream for stdin (on fd 0).
A Readable Stream for stdin (on fd 0).
process.stderr and process.stdout are unlike other streams in Node.js in that they cannot be closed (end() will throw), they never emit the finish event and that writes can block when output is redirected to a file (although disks are fast and operating systems normally employ write-back caching so it should be a very rare occurrence indeed.)
process.stderr and process.stdout are unlike other streams in Node.js in that they cannot be closed (end() will throw), they never emit the finish event and that writes can block when output is redirected to a file (although disks are fast and operating systems normally employ write-back caching so it should be a very rare occurrence indeed.)
Getter/setter to set what is displayed in ps.
Getter/setter to set what is displayed in ps. When used as a setter, the maximum length is platform-specific and probably short. On Linux and OS X, it's limited to the size of the binary name plus the length of the command line arguments because it overwrites the argv memory. v0.8 allowed for longer process title strings by also overwriting the environ memory but that was potentially insecure/confusing in some (rather obscure) cases.
Sets or reads the process's file mode creation 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 given, otherwise returns the current mask.
process.umask([mask])
Sets or reads the process's file mode creation 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 given, otherwise returns the current mask.
process.umask([mask])
Number of seconds Node.js has been running.
Number of seconds Node.js has been running.
process.uptime()
A compiled-in property that exposes NODE_VERSION.
A compiled-in property that exposes NODE_VERSION.
A property exposing version strings of Node.js and its dependencies.
A property exposing version strings of Node.js and its dependencies.
The process object. See the process object section.