doc: clarify when child process 'spawn' event is *not* emitted

Making this clarification in response to a comment on GitHub: #35288 (comment) PR-URL: #37833 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
nodejs · May 1, 2021 · b31bb72c10a303fff4682ac60a99f997f16ee53a · b31bb72
1 parent 2551bb1
commit b31bb72c10a303fff4682ac60a99f997f16ee53a
Showing with 2 additions and 0 deletions.

+2 −0 doc/api/child_process.md
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
@@ -1088,6 +1088,8 @@ added: REPLACEME
 -->
 
 The `'spawn'` event is emitted once the child process has spawned successfully.
+If the child process does not spawn successfully, the `'spawn'` event is not
+emitted and the `'error'` event is emitted instead.
 
 If emitted, the `'spawn'` event comes before all other events and before any
 data is received via `stdout` or `stderr`.