Skip to content

Commit

Permalink
doc: fix cluster worker 'message' event
Browse files Browse the repository at this point in the history
This commit adds the missing handle argument to the cluster
worker 'message' event. It also adds a link to the process
'message' event for reference.

Refs: #7297
PR-URL: #7309
Reviewed-By: Brian White <mscdex@mscdex.net>
  • Loading branch information
cjihrig authored and Myles Borins committed Jul 12, 2016
1 parent 8427ffc commit 7a8fc1f
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/api/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,12 +167,12 @@ It is not emitted in the worker.
### Event: 'message'

* `message` {Object}
* `handle` {undefined|Object}

Similar to the `cluster.on('message')` event, but specific to this worker.

This event is the same as the one provided by [`child_process.fork()`][].
Similar to the `cluster.on('message')` event, but specific to this worker. In a
worker you can also use `process.on('message')`.

In a worker you can also use `process.on('message')`.
See [`process` event: `'message'`][].

As an example, here is a cluster that keeps count of the number of requests
in the master process using the message system:
Expand Down Expand Up @@ -689,3 +689,4 @@ socket.on('data', (id) => {
[Child Process module]: child_process.html#child_process_child_process_fork_modulepath_args_options
[child_process event: 'exit']: child_process.html#child_process_event_exit
[child_process event: 'message']: child_process.html#child_process_event_message
[`process` event: `'message'`]: process.html#process_event_message

0 comments on commit 7a8fc1f

Please sign in to comment.