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]>
nodejs · Aug 16, 2018 · 399ba4b · 399ba4b
1 parent 83e704d
commit 399ba4b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/doc/api/child_process.md b/doc/api/child_process.md
@@ -620,6 +620,10 @@ pipes between the parent and child. The value is one of the following:
    will enable [`process.send()`][], [`process.disconnect()`][],
    [`process.on('disconnect')`][], and [`process.on('message')`] within the
    child.
+
+   Accessing the IPC channel fd in any way other than [`process.send()`][]
+   or using the IPC channel with a child process that is not a Node.js instance
+   is not supported.
 3. `'ignore'` - Instructs Node.js to ignore the fd in the child. While Node.js
    will always open fds 0 - 2 for the processes it spawns, setting the fd to
    `'ignore'` will cause Node.js to open `/dev/null` and attach it to the