From 399ba4b8d84ea34f3d063c31e703b26944834c37 Mon Sep 17 00:00:00 2001 From: Bartosz Sosnowski Date: Fri, 8 Dec 2017 11:56:53 +0100 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/17545 Reviewed-By: Matteo Collina Reviewed-By: James M Snell Reviewed-By: Ruben Bridgewater --- doc/api/child_process.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 620719111c48c8..f87d94efcd80cf 100755 --- 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