From 34045394e0222a8523ead5e6c6d299361151a5f1 Mon Sep 17 00:00:00 2001
From: "trop[bot]" <37223003+trop[bot]@users.noreply.github.com>
Date: Tue, 22 Oct 2024 19:22:05 +0200
Subject: [PATCH] docs: clarify utilityProcess child.pid value (#44364)

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>
---
 docs/api/utility-process.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/docs/api/utility-process.md b/docs/api/utility-process.md
index bb78e576490..f503fa9387f 100644
--- a/docs/api/utility-process.md
+++ b/docs/api/utility-process.md
@@ -86,9 +86,21 @@ true if the kill is successful, and false otherwise.
 #### `child.pid`
 
 A `Integer | undefined` representing the process identifier (PID) of the child process.
-If the child process fails to spawn due to errors, then the value is `undefined`. When
+Until the child process has spawned successfully, the value is `undefined`. When
 the child process exits, then the value is `undefined` after the `exit` event is emitted.
 
+```js
+const child = utilityProcess.fork(path.join(__dirname, 'test.js'))
+
+child.on('spawn', () => {
+  console.log(child.pid) // Integer
+})
+
+child.on('exit', () => {
+  console.log(child.pid) // undefined
+})
+```
+
 #### `child.stdout`
 
 A `NodeJS.ReadableStream | null` that represents the child process's stdout.