Skip to content

Commit

Permalink
Fixes Issue almende#3316 - Updates network documentation to account f…
Browse files Browse the repository at this point in the history
…or edge-case of how clusterByConnection uses the joinCondition callback
  • Loading branch information
MacLeod Broad committed Jul 30, 2017
1 parent 080b0f6 commit 0129c27
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/network/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1193,9 +1193,10 @@ <h4 id="optionsObject">Cluster methods options object</h4>
<th>Type</th>
<th>Description</th>
</tr>
<tr><td>joinCondition(<br>&nbsp;&nbsp;<code>nodeOptions:&nbsp;Object</code><br>)</td>
<tr><td>joinCondition(<br>&nbsp;&nbsp;<code>nodeOptions:&nbsp;Object</code><br>)<br>or<br>joinCondition(<br>&nbsp;&nbsp;<code>parentNodeOptions:&nbsp;Object,</code><br>&nbsp;&nbsp;<code>childNodeOptions:&nbsp;Object</code><br>)</td>
<td>Function</td>
<td><i>Optional for all but the cluster method. </i> The cluster module loops over all nodes that are
<td><i>Optional for all but the cluster method.
</i> The cluster module loops over all nodes that are
selected to be in the cluster and calls this function with their data as argument.
If this function returns true, this node will be added to the cluster. You have access to all
options
Expand All @@ -1219,6 +1220,7 @@ <h4 id="optionsObject">Cluster methods options object</h4>

network.clustering.cluster(options);
</pre>
<code>clusterByConnection</code><b> will pass 2 nodeOptions objects as arguments to the joinCondition callback.</b>
</td>
</tr>
<tr><td>processProperties(<br>&nbsp;&nbsp;<code>clusterOptions:&nbsp;Object</code>,<br>
Expand Down

0 comments on commit 0129c27

Please sign in to comment.