Skip to content

Commit ea1a076

Browse files
bzozBridgeAR
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: nodejs#17545 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent 33103e9 commit ea1a076

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
@@ -621,6 +621,10 @@ pipes between the parent and child. The value is one of the following:
621621
will enable [`process.send()`][], [`process.disconnect()`][],
622622
[`process.on('disconnect')`][], and [`process.on('message')`] within the
623623
child.
624+
625+
Accessing the IPC channel fd in any way other than [`process.send()`][]
626+
or using the IPC channel with a child process that is not a Node.js instance
627+
is not supported.
624628
3. `'ignore'` - Instructs Node.js to ignore the fd in the child. While Node.js
625629
will always open fds 0 - 2 for the processes it spawns, setting the fd to
626630
`'ignore'` will cause Node.js to open `/dev/null` and attach it to the

0 commit comments

Comments
 (0)