object Process extends Object with Process
- Annotations
- @native() @JSGlobal("process")
- Alphabetic
- By Inheritance
- Process
- Process
- IEventEmitter
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def abort(): Unit
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.
- Definition Classes
- Process
process.abort()
Example: - def addListener(eventName: String, listener: Function): Process.this.type
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
- Definition Classes
- IEventEmitter
emitter.addListener(eventName, listener)
- See also
on()
Example: - def allowedNodeEnvironmentFlags: EnvironmentFlags
- Definition Classes
- Process
- def arch: String
What processor architecture you're running on: 'arm', 'ia32', or 'x64'.
What processor architecture you're running on: 'arm', 'ia32', or 'x64'.
- Definition Classes
- Process
process.arch
Example: - def argv: Array[String]
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.
- Definition Classes
- Process
process.argv
Example: - def argv0: String
- Definition Classes
- Process
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def channel: UndefOr[Object]
- Definition Classes
- Process
- def chdir(directory: String): Unit
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.
- Definition Classes
- Process
process.chdir(directory)
Example: - def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def config: ProcessConfig
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.
- Definition Classes
- Process
- def connected: UndefOr[Boolean]
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
- Definition Classes
- Process
process.connected
Example: - def cpuUsage(): CpuUsage
- Definition Classes
- Process
- def cpuUsage(previousValue: CpuUsage): CpuUsage
- Definition Classes
- Process
- def cwd(): String
Returns the current working directory of the process.
Returns the current working directory of the process.
- Definition Classes
- Process
process.cwd()
Example: - def debugPort: Integer
Returns the debug port
Returns the debug port
- Definition Classes
- Process
- def disconnect(): Any
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.
- Definition Classes
- Process
process.disconnect()
Example: - def dlopen(module: Module, filename: String): Unit
- Definition Classes
- Process
- def dlopen(module: Module, filename: String, flags: Int): Unit
- Definition Classes
- Process
- val domain: Domain
- Definition Classes
- IEventEmitter
- def emit(name: String, args: Any*): Boolean
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.
- name
the event name
- args
the event arguments
- Definition Classes
- IEventEmitter
emitter.emit(name[, arg1][, arg2][, ...])
Example: - def emitWarning(warning: String): Unit
- Definition Classes
- Process
- def emitWarning(warning: String, type: String): Unit
- Definition Classes
- Process
- def emitWarning(warning: String, type: String, code: String): Unit
- Definition Classes
- Process
- def emitWarning(warning: String, ctor: Function): Unit
- Definition Classes
- Process
- def emitWarning(warning: String, type: String, ctor: Function): Unit
- Definition Classes
- Process
- def emitWarning(warning: String, type: String, code: String, ctor: Function): Unit
- Definition Classes
- Process
- def emitWarning(warning: String, options: WarningOptions): Unit
- Definition Classes
- Process
- def emitWarning(warning: Error): Unit
- Definition Classes
- Process
- def emitWarning(warning: Error, options: WarningOptions): Unit
- Definition Classes
- Process
- def env: Environment
An object containing the user environment.
An object containing the user environment.
- Definition Classes
- Process
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def eventNames(): Array[String]
- Definition Classes
- IEventEmitter
- def execArgv: Array[String]
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.
- Definition Classes
- Process
- Since
0.7.7
- def execPath: String
This is the absolute pathname of the executable that started the process.
This is the absolute pathname of the executable that started the process.
- Definition Classes
- Process
process.execPath
Example: - def exit(): Unit
- Definition Classes
- Process
- def exit(code: Int): Unit
Ends the process with the specified code.
Ends the process with the specified code. If omitted, exit uses the 'success' code 0.
- Definition Classes
- Process
process.exit([code])
Example: - def exitCode: Int
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.
- Definition Classes
- Process
process.exitCode
Example: - def features: Features
- Definition Classes
- Process
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getMaxListeners(): Int
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.
- Definition Classes
- IEventEmitter
emitter.getMaxListeners()
- See also
setMaxListeners()
Example: - def getegid(): Int
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)
- Definition Classes
- Process
process.getegid()
Example: - def geteuid(): Int
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)
- Definition Classes
- Process
process.geteuid()
Example: - def getgid(): Int
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)
- Definition Classes
- Process
process.getgid()
Example: - def getgroups(): Array[Int]
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.
- Definition Classes
- Process
process.getgroups()
Example: - def getuid(): Int
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)
- Definition Classes
- Process
process.getuid()
Example: - def hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
- def hasUncaughtExceptionCaptureCallback(): Boolean
- Definition Classes
- Process
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val hrtime: HrTime
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.
- Definition Classes
- Process
process.hrtime([time])
Example: - def initgroups(user: Int, extra_group: Int): Array[Int]
- Definition Classes
- Process
- def initgroups(user: Int, extra_group: String): Array[Int]
- Definition Classes
- Process
- def initgroups(user: String, extra_group: Int): Array[Int]
- Definition Classes
- Process
- def initgroups(user: String, extra_group: String): Array[Int]
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.
- Definition Classes
- Process
process.initgroups(user, extra_group)
Example: - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- def kill(pid: Int): Unit
- Definition Classes
- Process
- def kill(pid: Int, signal: Int): Unit
- Definition Classes
- Process
- def kill(pid: Int, signal: String): Unit
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.
- Definition Classes
- Process
process.kill(pid[, signal])
Example: - def listenerCount(eventName: String): Int
Returns the number of listeners listening to the event named eventName.
Returns the number of listeners listening to the event named eventName.
- Definition Classes
- IEventEmitter
emitter.listenerCount(eventName)
Example: - def listeners(eventName: String): Array[Function]
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.
- Definition Classes
- IEventEmitter
emitter.listeners(eventName)
Example: - def mainModule: UndefOr[Any]
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.
- Definition Classes
- Process
- def memoryUsage(): MemoryUsage
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.
- Definition Classes
- Process
process.memoryUsage()
Example: - def moduleLoadList: Array[String]
Returns the loaded module list
Returns the loaded module list
- Definition Classes
- Process
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nextTick(callback: Function0[Any], args: Any*): Unit
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.
- Definition Classes
- Process
process.nextTick(callback[, arg][, ...])
Example: - def noDeprecation: UndefOr[Boolean]
- Definition Classes
- Process
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def off(eventName: String, listner: Function): Process.this.type
- Definition Classes
- IEventEmitter
- def on(eventName: String, listener: Function): Process.this.type
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.
- Definition Classes
- IEventEmitter
emitter.on(eventName, listener)
Example: - def once(eventName: String, listener: Function): Process.this.type
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.
- Definition Classes
- IEventEmitter
emitter.once(eventName, listener)
Example: - def pid: Int
The PID of the process.
The PID of the process.
- Definition Classes
- Process
process.pid
Example: - def platform: String
What platform you're running on: 'darwin', 'freebsd', 'linux', 'sunos' or 'win32'
What platform you're running on: 'darwin', 'freebsd', 'linux', 'sunos' or 'win32'
- Definition Classes
- Process
- def ppid: Int
- Definition Classes
- Process
- def prependListener(eventName: String, listener: Function): Process.this.type
- Definition Classes
- IEventEmitter
- def prependOnceListener(eventName: String, listener: Function): Process.this.type
- Definition Classes
- IEventEmitter
- def propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- def rawListeners(eventName: String): Array[Function]
- Definition Classes
- IEventEmitter
- def release: ReleaseInfo
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.
- Definition Classes
- Process
- Since
3.0.0
- def removeAllListeners(): Process.this.type
- Definition Classes
- IEventEmitter
- def removeAllListeners(eventName: String): Process.this.type
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.
- Definition Classes
- IEventEmitter
emitter.removeAllListeners([eventName])
Example: - def removeListener(eventName: String, listener: Function): Process.this.type
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.
- Definition Classes
- IEventEmitter
emitter.removeListener(eventName, listener)
Example: - def report: UndefOr[Reporter]
- Definition Classes
- Process
- def resourceUsage(): ResourceUsage
- Definition Classes
- Process
- def send(message: Any): Boolean
- Definition Classes
- Process
- def send(message: Any, callback: Function): Boolean
- Definition Classes
- Process
- def send(message: Any, sendHandle: SendHandle): Boolean
- Definition Classes
- Process
- def send(message: Any, sendHandle: SendHandle, callback: Function): Boolean
- Definition Classes
- Process
- def send(message: Any, sendHandle: SendHandle, options: TransferOptions): Boolean
- Definition Classes
- Process
- def send(message: Any, sendHandle: SendHandle, options: TransferOptions, callback: Function): Boolean
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.
- Definition Classes
- Process
process.send(message[, sendHandle[, options]][, callback])
- Since
0.5.9
Example: - def setMaxListeners(n: Int): Process.this.type
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.
- Definition Classes
- IEventEmitter
emitter.setMaxListeners(n)
Example: - def setUncaughtExceptionCaptureCallback(): Unit
- Definition Classes
- Process
- def setUncaughtExceptionCaptureCallback(callback: Function): Unit
- Definition Classes
- Process
- def setegid(id: Int): Unit
- Definition Classes
- Process
- def setegid(id: String): Unit
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.
- Definition Classes
- Process
process.setegid(id)
- Since
2.0.0
Example: - def seteuid(id: Int): Unit
- Definition Classes
- Process
- def seteuid(id: String): Unit
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.
- Definition Classes
- Process
process.seteuid(id)
Example: - def setgid(id: Int): Unit
- Definition Classes
- Process
- def setgid(id: String): Unit
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.
- Definition Classes
- Process
process.setgid(id)
Example: - def setgroups(groups: Array[Int]): Unit
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.
- Definition Classes
- Process
process.setgroups(groups)
Example: - def setuid(id: Int): Unit
- Definition Classes
- Process
- def setuid(id: String): Unit
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.
- Definition Classes
- Process
process.setuid(id)
Example: - def stderr: WriteStream
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.)
- Definition Classes
- Process
- def stdin: ReadStream
A Readable Stream for stdin (on fd 0).
A Readable Stream for stdin (on fd 0).
- Definition Classes
- Process
- def stdout: WriteStream
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.)
- Definition Classes
- Process
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def throwDeprecation: UndefOr[Boolean]
- Definition Classes
- Process
- val title: String
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.
- Definition Classes
- Process
- def toLocaleString(): String
- Definition Classes
- Object
- def toString(): String
- Definition Classes
- AnyRef → Any
- def traceDeprecation: UndefOr[Boolean]
- Definition Classes
- Process
- def umask(mask: Int): Int
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.
- Definition Classes
- Process
process.umask([mask])
Example: - def uptime(): Int
Number of seconds Node.js has been running.
Number of seconds Node.js has been running.
- Definition Classes
- Process
process.uptime()
Example: - def valueOf(): Any
- Definition Classes
- Object
- def version: String
A compiled-in property that exposes NODE_VERSION.
A compiled-in property that exposes NODE_VERSION.
- Definition Classes
- Process
- def versions: ComponentVersion
A property exposing version strings of Node.js and its dependencies.
A property exposing version strings of Node.js and its dependencies.
- Definition Classes
- Process
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def umask(): Int
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.
- Definition Classes
- Process
- Annotations
- @deprecated
- Deprecated
(Since version Node.js v12.19.0) DEP0139: Use umask(mask) instead.
process.umask([mask])
Example: