Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: update spawnSync() status value possibilities #26680

Closed
wants to merge 4 commits into from
Closed

doc: update spawnSync() status value possibilities #26680

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
162e644
doc: update spawnSync() status value possibilities
Trott Mar 15, 2019
28367bb
fixup! doc: update spawnSync() status value possibilities
Trott Mar 17, 2019
321fff3
fixup! fixup! doc: update spawnSync() status value possibilities
Trott Mar 18, 2019
a81bd25
fixup! fixup! fixup! doc: update spawnSync() status value possibilities
Trott Mar 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/api/child_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,8 +868,10 @@ changes:
* `output` {Array} Array of results from stdio output.
* `stdout` {Buffer|string} The contents of `output[1]`.
* `stderr` {Buffer|string} The contents of `output[2]`.
* `status` {number} The exit code of the child process.
* `signal` {string} The signal used to kill the child process.
* `status` {number|null} The exit code of the subprocess, or `null` if the
subprocess ended due to a signal.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't object to "ended", but please be aware that its non-standard terminology: streams end, processes terminate, on both posixy and windowsy operating systems, see:

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll switch to terminate since it's the best term for this.

* `signal` {string|null} The signal used to kill the subprocess, or `null` if
the subprocess did not end due to a signal.
* `error` {Error} The error object if the child process failed or timed out.

The `child_process.spawnSync()` method is generally identical to
Expand Down