doc: Does child_process.execFile really resolve to a ChildProcess?
📗 API Reference Docs Problem
- Version: v14.5.0
- Platform: macOS (Darwin 19.5.0)
- Subsystem: child_process
Location
child_process.execFile
:
If this method is invoked as its util.promisify()ed version, it returns a Promise for an Object with stdout and stderr properties. The returned ChildProcess instance is attached to the Promise as a child property. In case of an error (including any error resulting in an exit code other than 0), a rejected promise is returned, with the same error object given in the callback, but with two additional properties stdout and stderr.
Affected URL(s):
- https://nodejs.org/dist/latest-v12.x/docs/api/child_process.html#child_process_child_process_execfile_file_args_options_callback
- https://nodejs.org/dist/latest-v14.x/docs/api/child_process.html#child_process_child_process_execfile_file_args_options_callback
Problem description
I'm trying to retrieve the status code of a process that was run using util.promisify(child_process.execFile)
; the documentation suggests that there should be a ChildProcess "child" property, but that doesn't seem to exist. The only mention of ChildProcess in the source code is the return value (which gets wiped out after the function is promisified, of course).
I don't think the documentation is clear enough on what it means here, and maybe a feature or bug request is also necessary.
-
I would like to work on this issue and submit a pull request.