Commit f8fb2c0
doc: linkify .fork() in cluster documentation
PR-URL: #30163
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>1 parent 348ec69 commit f8fb2c0
1 file changed
Lines changed: 7 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -531,7 +531,7 @@ added: v0.7.9 | |||
| 531 | 531 | ||
| 532 | 532 | When any of the workers die the cluster module will emit the `'exit'` event. | |
| 533 | 533 | ||
| 534 | - This can be used to restart the worker by calling `.fork()` again. | ||
| 534 | + This can be used to restart the worker by calling [`.fork()`][] again. | ||
| 535 | 535 | ||
| 536 | 536 | ```js | |
| 537 | 537 | cluster.on('exit', (worker, code, signal) => { | |
@@ -760,8 +760,8 @@ changes: | |||
| 760 | 760 | * `windowsHide` {boolean} Hide the forked processes console window that would | |
| 761 | 761 | normally be created on Windows systems. **Default:** `false`. | |
| 762 | 762 | ||
| 763 | - After calling `.setupMaster()` (or `.fork()`) this settings object will contain | ||
| 764 | - the settings, including the default values. | ||
| 763 | + After calling [`.setupMaster()`][] (or [`.fork()`][]) this settings object will | ||
| 764 | + contain the settings, including the default values. | ||
| 765 | 765 | ||
| 766 | 766 | This object is not intended to be changed or set manually. | |
| 767 | 767 | ||
@@ -779,11 +779,11 @@ changes: | |||
| 779 | 779 | `setupMaster` is used to change the default 'fork' behavior. Once called, | |
| 780 | 780 | the settings will be present in `cluster.settings`. | |
| 781 | 781 | ||
| 782 | - Any settings changes only affect future calls to `.fork()` and have no | ||
| 782 | + Any settings changes only affect future calls to [`.fork()`][] and have no | ||
| 783 | 783 | effect on workers that are already running. | |
| 784 | 784 | ||
| 785 | 785 | The only attribute of a worker that cannot be set via `.setupMaster()` is | |
| 786 | - the `env` passed to `.fork()`. | ||
| 786 | + the `env` passed to [`.fork()`][]. | ||
| 787 | 787 | ||
| 788 | 788 | The defaults above apply to the first call only; the defaults for later | |
| 789 | 789 | calls are the current values at the time of `cluster.setupMaster()` is called. | |
@@ -862,6 +862,8 @@ socket.on('data', (id) => { | |||
| 862 | 862 | }); | |
| 863 | 863 | ``` | |
| 864 | 864 | ||
| 865 | + [`.fork()`]: #cluster_cluster_fork_env | ||
| 866 | + [`.setupMaster()`]: #cluster_cluster_setupmaster_settings | ||
| 865 | 867 | [`ChildProcess.send()`]: child_process.html#child_process_subprocess_send_message_sendhandle_options_callback | |
| 866 | 868 | [`child_process.fork()`]: child_process.html#child_process_child_process_fork_modulepath_args_options | |
| 867 | 869 | [`child_process` event: `'exit'`]: child_process.html#child_process_event_exit | |
0 commit comments