child_process.fork(modulePath[, args][, options])
-
modulePath
<String> The module to run in the child -
args
<Array> List of string arguments -
options
<Object>-
cwd
<String> Current working directory of the child process -
env
<Object> Environment key-value pairs -
execPath
<String> Executable used to create the child process -
execArgv
<Array> List of string arguments passed to the executable (Default:process.execArgv
) -
silent
<Boolean> If true, stdin, stdout, and stderr of the child will be piped to the parent, otherwise they will be inherited from the parent, see the'pipe'
and'inherit'
options forchild_process.spawn()
'sstdio
for more details (default is false) -
uid
<Number> Sets the user identity of the process. (See setuid(2).) -
gid
<Number> Sets the group identity of the process. (See setgid(2).)
-
- Return: <ChildProcess>
The child_process.fork()
method is a special case of child_process.spawn()
used specifically to spawn new Node.js processes. Like child_process.spawn()
, a ChildProcess
object is returned. The returned ChildProcess
will have an additional communication channel built-in that allows messages to be passed back and forth between the parent and child. See ChildProcess#send()
for details.
It is important to keep in mind that spawned Node.js child processes are independent of the parent with exception of the IPC communication channel that is established between the two. Each process has it's own memory, with their own V8 instances. Because of the additional resource allocations required, spawning a large number of child Node.js processes is not recommended.
By default, child_process.fork()
will spawn new Node.js instances using the process.execPath
of the parent process. The execPath
property in the options
object allows for an alternative execution path to be used.
Node.js processes launched with a custom execPath
will communicate with the parent process using the file descriptor (fd) identified using the environment variable NODE_CHANNEL_FD
on the child process. The input and output on this fd is expected to be line delimited JSON objects.
Note: Unlike the fork()
POSIX system call, child_process.fork()
does not clone the current process.
Please login to continue.