Either Cluster API doc or Cluster event 'message' argument is wrong

[bennosom]

https://nodejs.org/dist/latest-v5.x/docs/api/cluster.html#cluster_event_message_1
Cluster event 'message' has two arguments: worker object and message? Really? I will only get one argument - the message.

Env: Windows, 64bit, v5.5.0

Would be nice if there is a worker object, because it makes life easier...

[mscdex]

@bennosom That's for the master. The worker process only has a message argument.

[bennosom]

Yes, I agree with you. The master should have two arguments, but it has not:

var cluster = require('cluster');
if (cluster.isMaster) {
    cluster.fork();
    cluster.on('message', (worker, message) => {
        console.log(worker, message); // <-- prints: hello undefined
    });
} else {
    process.send('hello');
}

I would expect the worker object as first argument as mentioned in the docs (see https://nodejs.org/dist/latest-v5.x/docs/api/cluster.html#cluster_event_message_1).

[bnoordhuis]

The documentation is at odds with the test coverage here.

@sam-github Is that an oversight in commit 66fc8ca? The intent was to emit the worker as the first argument?

[sam-github]

I'm sorry, yes, it was an oversight, the intention was to emit the worker as the first argument, consistent with the other events on master.

[bnoordhuis]

#5361