doc: clarify child_process close event

clarify the 'close' event description in the child_process docs. fixes: #37998 PR-URL: #38181 Fixes: #37998 Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Apr 15, 2021 · 7997ae1 · 7997ae1
1 parent b61ff83
commit 7997ae1
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
@@ -1065,9 +1065,11 @@ added: v0.7.7
 * `code` {number} The exit code if the child exited on its own.
 * `signal` {string} The signal by which the child process was terminated.
 
-The `'close'` event is emitted when the stdio streams of a child process have
-been closed. This is distinct from the [`'exit'`][] event, since multiple
-processes might share the same stdio streams.
+The `'close'` event is emitted after a process has ended _and_ the stdio
+streams of a child process have been closed. This is distinct from the
+[`'exit'`][] event, since multiple processes might share the same stdio
+streams. The `'close'` event will always emit after [`'exit'`][] was
+already emitted, or [`'error'`][] if the child failed to spawn.
 
 ```js
 const { spawn } = require('child_process');