Skip to content
Permalink
Browse files

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: #26995
PR-URL: #29868
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
  • Loading branch information
dev-313 authored and targos committed Oct 7, 2019
1 parent d0f5bc1 commit 98d31da342d460cb4589dfb9c8362e50b8bb3794
Showing with 12 additions and 2 deletions.
  1. +7 −1 doc/api/cluster.md
  2. +5 −1 doc/api/process.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}

@@ -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}

0 comments on commit 98d31da

Please sign in to comment.
You can’t perform that action at this time.