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

nodejs / node Public

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

• Code
• Issues 635
• Pull requests 754
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 80cc17f

Browse filesBrowse the repository at this point in the historyBrowse files

RaisinTen

authored and

targos

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 b4df8d3 commit 80cc17f
Copy full SHA for 80cc17f

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

0 commit comments

Comments

0 (0)