From d6d21d610a90d9a2d8959f385d43667d693bca4a Mon Sep 17 00:00:00 2001 From: dev-313 Date: Mon, 7 Oct 2019 23:46:03 +0530 Subject: [PATCH 1/5] doc: add options description for process.send() and worker.send() 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 --- doc/api/cluster.md | 6 ++++++ doc/api/process.md | 7 ++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 6ea11b08ae2a16..85f2e3293a547f 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -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 eedbfeefdd7d40..895a4aaa5c322c 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1942,7 +1942,12 @@ added: v0.5.9 * `message` {Object} * `sendHandle` {net.Server|net.Socket} -* `options` {Object} +* `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} From 356dcb9358d03dea73a89054ee5b8b3b813db957 Mon Sep 17 00:00:00 2001 From: dev-313 Date: Wed, 16 Oct 2019 00:24:06 +0530 Subject: [PATCH 2/5] doc: change options description for process.send() --- doc/api/process.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/api/process.md b/doc/api/process.md index 895a4aaa5c322c..d3114025494fcd 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1942,9 +1942,14 @@ added: v0.5.9 * `message` {Object} * `sendHandle` {net.Server|net.Socket} +<<<<<<< Updated upstream * `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: +======= +* `options` {Object} used to parameterize the sending of certain types of + handles.`options` supports the following properties: +>>>>>>> Stashed changes * `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`. From ba5bf9de7ea9f1061a0df960f0ac94ccb30ef6ed Mon Sep 17 00:00:00 2001 From: dev-313 Date: Thu, 17 Oct 2019 01:03:30 +0530 Subject: [PATCH 3/5] doc: change options description for process.md() Fixes: https://github.com/nodejs/node/issues/26995 --- doc/api/process.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/doc/api/process.md b/doc/api/process.md index d3114025494fcd..9126ae5728c847 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1942,14 +1942,8 @@ added: v0.5.9 * `message` {Object} * `sendHandle` {net.Server|net.Socket} -<<<<<<< Updated upstream -* `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: -======= * `options` {Object} used to parameterize the sending of certain types of handles.`options` supports the following properties: ->>>>>>> Stashed changes * `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`. From 691ebd2247dc4025b61b67e5ee152ec95b64f24f Mon Sep 17 00:00:00 2001 From: dev-313 Date: Thu, 17 Oct 2019 13:21:23 +0530 Subject: [PATCH 4/5] doc: trim trailing whitespace from doc/api/process.md --- doc/api/process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/process.md b/doc/api/process.md index 9126ae5728c847..6b7529327fcedb 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1942,7 +1942,7 @@ added: v0.5.9 * `message` {Object} * `sendHandle` {net.Server|net.Socket} -* `options` {Object} used to parameterize the sending of certain types of +* `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. From 0ccba0da11e2a99a91f755132c8ea949eff8698d Mon Sep 17 00:00:00 2001 From: dev-313 Date: Mon, 21 Oct 2019 23:11:26 +0530 Subject: [PATCH 5/5] doc: Changes in worker.send() API signature. Add 'options' argument in worker.send() (doc/api/cluster.md) API signature. Fixes: https://github.com/nodejs/node/issues/26995 --- doc/api/cluster.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 85f2e3293a547f..9f33689730023b 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\])