cluster.worker description and examples ere missing from the top leve…

…l of docs
nodejs · Sep 6, 2012 · 0087bc6 · 0087bc6
1 parent 052e63f
commit 0087bc6
Showing 1 changed file with 18 additions and 1 deletion.
diff --git a/doc/api/cluster.markdown b/doc/api/cluster.markdown
@@ -252,12 +252,29 @@ die graceful if no other event is waiting.
 
 The method takes an optional callback argument which will be called when finished.
 
+## cluster.worker
+
+* {Object}
+
+A reference to the current worker object. Not available in the master process.
+
+    var cluster = require('cluster');
+
+    if (cluster.isMaster) {
+      console.log('I am master');
+      cluster.fork();
+      cluster.fork();
+    } else if (cluster.isWorker) {
+      console.log('I am worker #' + cluster.worker.id);
+    }
+
 ## cluster.workers
 
 * {Object}
 
 A hash that stores the active worker objects, keyed by `id` field. Makes it
-easy to loop through all the workers.
+easy to loop through all the workers. It is only available in the master
+process.
 
     // Go through all workers
     function eachWorker(callback) {