Skip to content

doc: clarify spawnSync waits for stdio EOF #67198

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

Closed
helmipradita wants to merge 1 commit into from
Closed

doc: clarify spawnSync waits for stdio EOF #67198

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 1 deletion doc/api/child_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1432,7 +1432,11 @@ changes:

The `child_process.spawnSync()` method is generally identical to
[`child_process.spawn()`][] with the exception that the function will not return
until the child process has fully closed. When a timeout has been encountered
until the child process has fully closed and all stdio streams have reached EOF.
If the spawned process spawns a detached background child that inherits standard
I/O streams, those open descriptors can keep stdio streams open after the spawned
process has exited, causing `spawnSync()` to wait until all descriptors close or
the configured `timeout` expires. When a timeout has been encountered
and `killSignal` is sent, the method won't return until the process has
completely exited. If the process intercepts and handles the `SIGTERM` signal
and doesn't exit, the parent process will wait until the child process has
Expand Down