From 98d31da342d460cb4589dfb9c8362e50b8bb3794 Mon Sep 17 00:00:00 2001
From: dev-313 <shekhawat.dev313@gmail.com>
Date: Mon, 7 Oct 2019 23:46:03 +0530
Subject: [PATCH] doc: add options description for send APIs

Describes the meaning of the boolean return in process.send()
(doc/api/process.md) and worker.send() (doc/api/cluster.md) as
described in subprocess.send() (doc/api/child_process.md)

Fixes: https://github.com/nodejs/node/issues/26995
PR-URL: https://github.com/nodejs/node/pull/29868
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
---
 doc/api/cluster.md | 8 +++++++-
 doc/api/process.md | 6 +++++-
 2 files changed, 12 insertions(+), 2 deletions(-)

diff --git a/doc/api/cluster.md b/doc/api/cluster.md
index 972309a7013690..179a775074a394 100644
--- a/doc/api/cluster.md
+++ b/doc/api/cluster.md
@@ -456,7 +456,7 @@ Workers will call `process.exit(0)` if the `'disconnect'` event occurs
 on `process` and `.exitedAfterDisconnect` is not `true`. This protects against
 accidental disconnection.
 
-### worker.send(message\[, sendHandle\]\[, callback\])
+### worker.send(message\[, sendHandle\[, options\]\]\[, callback\])
 <!-- YAML
 added: v0.7.0
 changes:
@@ -467,6 +467,12 @@ changes:
 
 * `message` {Object}
 * `sendHandle` {Handle}
+* `options` {Object} The `options` argument, if present, is an object used to
+  parameterize the sending of certain types of handles. `options` supports
+  the following properties:
+  * `keepOpen` {boolean} A value that can be used when passing instances of
+    `net.Socket`. When `true`, the socket is kept open in the sending process.
+    **Default:** `false`.
 * `callback` {Function}
 * Returns: {boolean}
 
diff --git a/doc/api/process.md b/doc/api/process.md
index dd1ecba98e6809..79c423f752cd60 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -1940,7 +1940,11 @@ added: v0.5.9
 
 * `message` {Object}
 * `sendHandle` {net.Server|net.Socket}
-* `options` {Object}
+* `options` {Object} used to parameterize the sending of certain types of
+  handles.`options` supports the following properties:
+  * `keepOpen` {boolean} A value that can be used when passing instances of
+    `net.Socket`. When `true`, the socket is kept open in the sending process.
+    **Default:** `false`.
 * `callback` {Function}
 * Returns: {boolean}