doc: explain child_process code and signal null values everywhere · nodejs/node@5a917bc · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 632
• Pull requests 746
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 5a917bc

Browse filesBrowse the repository at this point in the historyBrowse files

RaisinTen

authored and

aduh95

committed

doc: explain child_process code and signal null values everywhere

Refs: #58463 (comment) Signed-off-by: Darshan Sen <raisinten@gmail.com> PR-URL: #58479 Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

1 parent 59806b4 commit 5a917bc
Copy full SHA for 5a917bc

1 file changed

+13-4Lines changed: 13 additions & 4 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • child_process.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/child_process.md‎

Copy file name to clipboardExpand all lines: doc/api/child_process.md

+13-4Lines changed: 13 additions & 4 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -1446,15 +1446,22 @@ instances of `ChildProcess`.
1446	1446	added: v0.7.7
1447	1447	-->
1448	1448
1449		- * `code` {number} The exit code if the child process exited on its own.
1450		- * `signal` {string} The signal by which the child process was terminated.
	1449	+ * `code` {number} The exit code if the child process exited on its own, or
	1450	+ `null` if the child process terminated due to a signal.
	1451	+ * `signal` {string} The signal by which the child process was terminated, or
	1452	+ `null` if the child process did not terminated due to a signal.
1451	1453
1452	1454	The `'close'` event is emitted after a process has ended _and_ the stdio
1453	1455	streams of a child process have been closed. This is distinct from the
1454	1456	[`'exit'`][] event, since multiple processes might share the same stdio
1455	1457	streams. The `'close'` event will always emit after [`'exit'`][] was
1456	1458	already emitted, or [`'error'`][] if the child process failed to spawn.
1457	1459
	1460	+ If the process exited, `code` is the final exit code of the process, otherwise
	1461	+ `null`. If the process terminated due to receipt of a signal, `signal` is the
	1462	+ string name of the signal, otherwise `null`. One of the two will always be
	1463	+ non-`null`.
	1464	+
1458	1465	```cjs
1459	1466	const { spawn } = require('node:child_process');
1460	1467	const ls = spawn('ls', ['-lh', '/usr']);
@@ -1524,8 +1531,10 @@ See also [`subprocess.kill()`][] and [`subprocess.send()`][].
1524	1531	added: v0.1.90
1525	1532	-->
1526	1533
1527		- * `code` {number} The exit code if the child process exited on its own.
1528		- * `signal` {string} The signal by which the child process was terminated.
	1534	+ * `code` {number} The exit code if the child process exited on its own, or
	1535	+ `null` if the child process terminated due to a signal.
	1536	+ * `signal` {string} The signal by which the child process was terminated, or
	1537	+ `null` if the child process did not terminated due to a signal.
1529	1538
1530	1539	The `'exit'` event is emitted after the child process ends. If the process
1531	1540	exited, `code` is the final exit code of the process, otherwise `null`. If the

0 commit comments

Comments

0 (0)