Commit 312ebd9
authored
doc: edit ChildProcess 'message' event docs
- Clarify which types of objects can be sent through `process.send`.
- Clarify that IPC handles are not supported on win32 platform.
PR-URL: #52154
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>1 parent f1635f4 commit 312ebd9
1 file changed
Lines changed: 7 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1222,8 +1222,8 @@ added: v0.5.9 | |||
| 1222 | 1222 | --> | |
| 1223 | 1223 | ||
| 1224 | 1224 | * `message` {Object} A parsed JSON object or primitive value. | |
| 1225 | - * `sendHandle` {Handle} A [`net.Socket`][] or [`net.Server`][] object, or | ||
| 1226 | - undefined. | ||
| 1225 | + * `sendHandle` {Handle|undefined} `undefined` or a [`net.Socket`][], | ||
| 1226 | + [`net.Server`][], or [`dgram.Socket`][] object. | ||
| 1227 | 1227 | ||
| 1228 | 1228 | The `'message'` event is triggered when a child process uses | |
| 1229 | 1229 | [`process.send()`][] to send messages. | |
@@ -1481,7 +1481,8 @@ changes: | |||
| 1481 | 1481 | --> | |
| 1482 | 1482 | ||
| 1483 | 1483 | * `message` {Object} | |
| 1484 | - * `sendHandle` {Handle} | ||
| 1484 | + * `sendHandle` {Handle|undefined} `undefined`, or a [`net.Socket`][], | ||
| 1485 | + [`net.Server`][], or [`dgram.Socket`][] object. | ||
| 1485 | 1486 | * `options` {Object} The `options` argument, if present, is an object used to | |
| 1486 | 1487 | parameterize the sending of certain types of handles. `options` supports | |
| 1487 | 1488 | the following properties: | |
@@ -1539,7 +1540,8 @@ The optional `sendHandle` argument that may be passed to `subprocess.send()` is | |||
| 1539 | 1540 | for passing a TCP server or socket object to the child process. The child will | |
| 1540 | 1541 | receive the object as the second argument passed to the callback function | |
| 1541 | 1542 | registered on the [`'message'`][] event. Any data that is received | |
| 1542 | - and buffered in the socket will not be sent to the child. | ||
| 1543 | + and buffered in the socket will not be sent to the child. Sending IPC sockets is | ||
| 1544 | + not supported on Windows. | ||
| 1543 | 1545 | ||
| 1544 | 1546 | The optional `callback` is a function that is invoked after the message is | |
| 1545 | 1547 | sent but before the child may have received it. The function is called with a | |
@@ -1872,6 +1874,7 @@ or [`child_process.fork()`][]. | |||
| 1872 | 1874 | [`child_process.fork()`]: #child_processforkmodulepath-args-options | |
| 1873 | 1875 | [`child_process.spawn()`]: #child_processspawncommand-args-options | |
| 1874 | 1876 | [`child_process.spawnSync()`]: #child_processspawnsynccommand-args-options | |
| 1877 | + [`dgram.Socket`]: dgram.md#class-dgramsocket | ||
| 1875 | 1878 | [`maxBuffer` and Unicode]: #maxbuffer-and-unicode | |
| 1876 | 1879 | [`net.Server`]: net.md#class-netserver | |
| 1877 | 1880 | [`net.Socket`]: net.md#class-netsocket | |
0 commit comments