diff options
author | Rich Trott <rtrott@gmail.com> | 2019-03-15 05:10:28 -0700 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-03-18 12:20:22 -0700 |
commit | 5fc6c1daed2ef41fda5147904ef8240a399f7943 (patch) | |
tree | e59f6f0fc13295a7563ebf4955d6bba5877610c0 /doc/api/child_process.md | |
parent | d6f6d7f8541327b72667d38777c47b9ea675125d (diff) | |
download | android-node-v8-5fc6c1daed2ef41fda5147904ef8240a399f7943.tar.gz android-node-v8-5fc6c1daed2ef41fda5147904ef8240a399f7943.tar.bz2 android-node-v8-5fc6c1daed2ef41fda5147904ef8240a399f7943.zip |
doc: update spawnSync() status value possibilities
The object returned by `child_process.spawnSync()` can have the `status`
property set to `null` if the process terminated due to a signal. We
even test for this in
test/parallel/test-child-process-spawnsync-kill-signal.js.
Update the documentation to reflect this.
PR-URL: https://github.com/nodejs/node/pull/26680
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Michaƫl Zasso <targos@protonmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Diffstat (limited to 'doc/api/child_process.md')
-rw-r--r-- | doc/api/child_process.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/api/child_process.md b/doc/api/child_process.md index a6064ee3c7..a3bdfc15c3 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -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 terminated due to a signal. + * `signal` {string|null} The signal used to kill the subprocess, or `null` if + the subprocess did not terminate 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 |