diff options
author | Gibson Fahnestock <gibfahn@gmail.com> | 2017-06-18 20:53:54 +0100 |
---|---|---|
committer | Ruben Bridgewater <ruben@bridgewater.de> | 2017-09-28 02:26:56 -0300 |
commit | 1175c9dca38e7ce5840dec3905586db9e2bbb4c1 (patch) | |
tree | 524b3f5b897e636f5f490081c70cc22763f2deee /doc/api/cluster.md | |
parent | ccfcd8873cf4966380322f89e34ce47441868c9d (diff) | |
download | node-new-1175c9dca38e7ce5840dec3905586db9e2bbb4c1.tar.gz |
doc: standardize function param/object prop style
PR-URL: https://github.com/nodejs/node/pull/13769
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/cluster.md')
-rw-r--r-- | doc/api/cluster.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/api/cluster.md b/doc/api/cluster.md index cce0f8479b..4e2b4eab88 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -147,8 +147,8 @@ Within a worker, `process.on('error')` may also be used. added: v0.11.2 --> -* `code` {number} the exit code, if it exited normally. -* `signal` {string} the name of the signal (e.g. `'SIGHUP'`) that caused +* `code` {number} The exit code, if it exited normally. +* `signal` {string} The name of the signal (e.g. `'SIGHUP'`) that caused the process to be killed. Similar to the `cluster.on('exit')` event, but specific to this worker. @@ -429,7 +429,7 @@ changes: * `message` {Object} * `sendHandle` {Handle} * `callback` {Function} -* Returns: Boolean +* Returns: {boolean} Send a message to a worker or master, optionally with a handle. @@ -480,8 +480,8 @@ added: v0.7.9 --> * `worker` {cluster.Worker} -* `code` {number} the exit code, if it exited normally. -* `signal` {string} the name of the signal (e.g. `'SIGHUP'`) that caused +* `code` {number} The exit code, if it exited normally. +* `signal` {string} The name of the signal (e.g. `'SIGHUP'`) that caused the process to be killed. When any of the workers die the cluster module will emit the `'exit'` event. @@ -630,8 +630,8 @@ If accuracy is important, use `cluster.settings`. added: v0.7.7 --> -* `callback` {Function} called when all workers are disconnected and handles are - closed +* `callback` {Function} Called when all workers are disconnected and handles are + closed. Calls `.disconnect()` on each worker in `cluster.workers`. @@ -648,7 +648,7 @@ added: v0.6.0 --> * `env` {Object} Key/value pairs to add to worker process environment. -* return {cluster.Worker} +* Returns: {cluster.Worker} Spawn a new worker process. @@ -709,9 +709,9 @@ changes: executable. (Default=`process.execArgv`) * `exec` {string} File path to worker file. (Default=`process.argv[1]`) * `args` {Array} String arguments passed to worker. - (Default=`process.argv.slice(2)`) + **Default:** `process.argv.slice(2)` * `silent` {boolean} Whether or not to send output to parent's stdio. - (Default=`false`) + **Default:** `false` * `stdio` {Array} Configures the stdio of forked processes. Because the cluster module relies on IPC to function, this configuration must contain an `'ipc'` entry. When this option is provided, it overrides `silent`. |