Skip to content

Commit 33271e6

Browse files
bzozMylesBorins
authored andcommitted
doc: mark accessing IPC channel fd as undefined
Adds note that accessing the fd of the IPC channel in any other way than process.send, or using the IPC channel with child processes that is not Node.js is not supported. PR-URL: #17545 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]>
1 parent fa0b987 commit 33271e6

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

doc/api/child_process.md

+4
Original file line numberDiff line numberDiff line change
@@ -620,6 +620,10 @@ pipes between the parent and child. The value is one of the following:
620620
will enable [`process.send()`][], [`process.disconnect()`][],
621621
[`process.on('disconnect')`][], and [`process.on('message')`] within the
622622
child.
623+
624+
Accessing the IPC channel fd in any way other than [`process.send()`][]
625+
or using the IPC channel with a child process that is not a Node.js instance
626+
is not supported.
623627
3. `'ignore'` - Instructs Node.js to ignore the fd in the child. While Node.js
624628
will always open fds 0 - 2 for the processes it spawns, setting the fd to
625629
`'ignore'` will cause Node.js to open `/dev/null` and attach it to the

0 commit comments

Comments
 (0)