Skip to content

Commit

Permalink
doc: document missing properties in child_process
Browse files Browse the repository at this point in the history
Add documentation for subprocess.exitCode, subprocess.signalCode,
subprocess.spawnargs, and subprocess.spawnfile.

PR-URL: #31342
Fixes: #27206
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Rich Trott <rtrott@gmail.com>
  • Loading branch information
HarshithaKP authored and Trott committed Jan 16, 2020
1 parent 9bfa4a9 commit 3299de8
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -1075,6 +1075,13 @@ When the child process is a Node.js instance (e.g. spawned using
[`child_process.fork()`][]), the `process.disconnect()` method can be invoked
within the child process to close the IPC channel as well.

### `subprocess.exitCode`

* {integer}

The `subprocess.exitcode` property indicates the exit code of the child process.
If the child process is still running, the field will be null.

### `subprocess.kill([signal])`
<!-- YAML
added: v0.1.90
Expand Down Expand Up @@ -1368,6 +1375,34 @@ It is also recommended that any `'message'` handlers in the child process
verify that `socket` exists, as the connection may have been closed during the
time it takes to send the connection to the child.

### `subprocess.signalCode`

* {integer}

The `subprocess.signalCode` property indicates the signal number received by
the child process if any, else null.

### `subprocess.spawnargs`

* {Array}

The `subprocess.spawnargs` property represents the full list of command line
arguments the child process was launched with.

### `subprocess.spawnfile`

* {string}

The `subprocess.spawnfile` property indicates the executable file name of
the child process that is launched.

For [`child_process.fork()`][], its value will be equal to
[`process.execPath`][].
For [`child_process.spawn()`][], its value will be the name of
the executable file.
For [`child_process.exec()`][], its value will be the name of the shell
in which the child process is launched.

### `subprocess.stderr`
<!-- YAML
added: v0.1.90
Expand Down

0 comments on commit 3299de8

Please sign in to comment.