summaryrefslogtreecommitdiff
path: root/doc/api/cluster.md
diff options
context:
space:
mode:
authorSean Villars <stvillars8@gmail.com>2016-12-01 11:30:34 -0600
committerSam Roberts <vieuxtech@gmail.com>2016-12-19 09:46:31 -0800
commit5d146021811c41def88208e60977eddbf0d6f125 (patch)
treee34dc76b3b2112e3ca14acfef0561602395f7da0 /doc/api/cluster.md
parent5e781a38834c4195d96c860e643dde850e8b7e6e (diff)
downloadandroid-node-v8-5d146021811c41def88208e60977eddbf0d6f125.tar.gz
android-node-v8-5d146021811c41def88208e60977eddbf0d6f125.tar.bz2
android-node-v8-5d146021811c41def88208e60977eddbf0d6f125.zip
cluster: return worker reference from disconnect()
Changes disconnect() to return a refererence to the worker. This will enable method chaining such as worker.disconnect().once('disconnect', doThis); PR-URL: https://github.com/nodejs/node/pull/10019 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Diffstat (limited to 'doc/api/cluster.md')
-rw-r--r--doc/api/cluster.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/api/cluster.md b/doc/api/cluster.md
index c323282d0f..f3c8017da1 100644
--- a/doc/api/cluster.md
+++ b/doc/api/cluster.md
@@ -257,6 +257,8 @@ It is not emitted in the worker.
added: v0.7.7
-->
+* Returns: {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.