Skip to content
Permalink
Browse files

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>
  • Loading branch information
addaleax authored and targos committed Oct 29, 2019
1 parent b654673 commit d7bfc6c9875899a24c6e4cb6b4aa2f36e2e9fd2c
Showing with 7 additions and 5 deletions.
  1. +7 −5 doc/api/cluster.md
@@ -531,7 +531,7 @@ added: v0.7.9

When any of the workers die the cluster module will emit the `'exit'` event.

This can be used to restart the worker by calling `.fork()` again.
This can be used to restart the worker by calling [`.fork()`][] again.

```js
cluster.on('exit', (worker, code, signal) => {
@@ -760,8 +760,8 @@ changes:
* `windowsHide` {boolean} Hide the forked processes console window that would
normally be created on Windows systems. **Default:** `false`.

After calling `.setupMaster()` (or `.fork()`) this settings object will contain
the settings, including the default values.
After calling [`.setupMaster()`][] (or [`.fork()`][]) this settings object will
contain the settings, including the default values.

This object is not intended to be changed or set manually.

@@ -779,11 +779,11 @@ changes:
`setupMaster` is used to change the default 'fork' behavior. Once called,
the settings will be present in `cluster.settings`.

Any settings changes only affect future calls to `.fork()` and have no
Any settings changes only affect future calls to [`.fork()`][] and have no
effect on workers that are already running.

The only attribute of a worker that cannot be set via `.setupMaster()` is
the `env` passed to `.fork()`.
the `env` passed to [`.fork()`][].

The defaults above apply to the first call only; the defaults for later
calls are the current values at the time of `cluster.setupMaster()` is called.
@@ -862,6 +862,8 @@ socket.on('data', (id) => {
});
```

[`.fork()`]: #cluster_cluster_fork_env
[`.setupMaster()`]: #cluster_cluster_setupmaster_settings
[`ChildProcess.send()`]: child_process.html#child_process_subprocess_send_message_sendhandle_options_callback
[`child_process.fork()`]: child_process.html#child_process_child_process_fork_modulepath_args_options
[`child_process` event: `'exit'`]: child_process.html#child_process_event_exit

0 comments on commit d7bfc6c

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