summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authordev-313 <shekhawat.dev313@gmail.com>2019-10-07 23:46:03 +0530
committerGireesh Punathil <gpunathi@in.ibm.com>2019-10-30 20:31:21 +0530
commit5d1578d85b6f09d827a6fe954d0617e1c13267b3 (patch)
tree31142be46b882f347802a76944939c7d52b529a7 /doc
parent6f39f105435ffd5e71ece41266ef3c256b29dc88 (diff)
downloadandroid-node-v8-5d1578d85b6f09d827a6fe954d0617e1c13267b3.tar.gz
android-node-v8-5d1578d85b6f09d827a6fe954d0617e1c13267b3.tar.bz2
android-node-v8-5d1578d85b6f09d827a6fe954d0617e1c13267b3.zip
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>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/cluster.md8
-rw-r--r--doc/api/process.md6
2 files changed, 12 insertions, 2 deletions
diff --git a/doc/api/cluster.md b/doc/api/cluster.md
index 972309a701..179a775074 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 718ab002d3..9fa2b78654 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}