diff options
| author | estrada9166 <estrada9166@hotmail.com> | 2018-02-12 02:31:55 -0500 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2018-02-23 16:26:29 +0000 |
| commit | a29089d7c866955616c0e363843017e9b9b2a736 (patch) | |
| tree | 28bb543eea1a6bd814da31d854daa8680fdc5a90 /doc/api/cluster.md | |
| parent | 3a191229418dcc0e21956847993b1702c88a923b (diff) | |
| download | android-node-v8-a29089d7c866955616c0e363843017e9b9b2a736.tar.gz android-node-v8-a29089d7c866955616c0e363843017e9b9b2a736.tar.bz2 android-node-v8-a29089d7c866955616c0e363843017e9b9b2a736.zip | |
doc: add new documentation lint rule
Add 80 characters limit to docs.
Change docs to fit 80 characters per row.
PR-URL: https://github.com/nodejs/node/pull/18726
Fixes: https://github.com/nodejs/node/issues/18703
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Diffstat (limited to 'doc/api/cluster.md')
| -rw-r--r-- | doc/api/cluster.md | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 11be4d34d5..08a669e4fa 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -269,8 +269,8 @@ changes: * Returns: {cluster.Worker} A reference to `worker`. -In a worker, this function will close all servers, wait for the `'close'` event on -those servers, and then disconnect the IPC channel. +In a worker, this function will close all servers, wait for the `'close'` event +on those servers, and then disconnect the IPC channel. In the master, an internal message is sent to the worker causing it to call `.disconnect()` on itself. @@ -280,8 +280,8 @@ Causes `.exitedAfterDisconnect` to be set. Note that after a server is closed, it will no longer accept new connections, but connections may be accepted by any other listening worker. Existing connections will be allowed to close as usual. When no more connections exist, -see [`server.close()`][], the IPC channel to the worker will close allowing it to -die gracefully. +see [`server.close()`][], the IPC channel to the worker will close allowing it +to die gracefully. The above applies *only* to server connections, client connections are not automatically closed by workers, and disconnect does not wait for them to close @@ -465,9 +465,9 @@ Emitted after the worker IPC channel has disconnected. This can occur when a worker exits gracefully, is killed, or is disconnected manually (such as with worker.disconnect()). -There may be a delay between the `'disconnect'` and `'exit'` events. These events -can be used to detect if the process is stuck in a cleanup or if there are -long-living connections. +There may be a delay between the `'disconnect'` and `'exit'` events. These +events can be used to detect if the process is stuck in a cleanup or if there +are long-living connections. ```js cluster.on('disconnect', (worker) => { @@ -639,7 +639,8 @@ Calls `.disconnect()` on each worker in `cluster.workers`. When they are disconnected all internal handles will be closed, allowing the master process to die gracefully if no other event is waiting. -The method takes an optional callback argument which will be called when finished. +The method takes an optional callback argument which will be called when +finished. This can only be called from the master process. |