Skip to content

Commit a97002e

Browse files
nucleardreamernucleardreamer
committed
server constructor options
1 parent 8b09c85 commit a97002e

17 files changed

+321
-162
lines changed

‎docs/Logger.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ <h5>Parameters:</h5>
149149
<td class="type">
150150

151151

152-
<span class="param-type">object</span>
152+
<span class="param-type">Object</span>
153153

154154

155155

@@ -271,7 +271,7 @@ <h6>Properties</h6>
271271
<td class="type">
272272

273273

274-
<span class="param-type">object</span>
274+
<span class="param-type">Object</span>
275275

276276

277277

@@ -415,7 +415,7 @@ <h5>Returns:</h5>
415415
<br class="clear">
416416

417417
<footer>
418-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 00:09:30 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
418+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
419419
</footer>
420420

421421
<script>prettyPrint();</script>

‎docs/Message.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1309,7 +1309,7 @@ <h5>Returns:</h5>
13091309
<br class="clear">
13101310

13111311
<footer>
1312-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 00:09:30 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
1312+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
13131313
</footer>
13141314

13151315
<script>prettyPrint();</script>

‎docs/WebSocketClient.html‎

Lines changed: 79 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ <h2>
5757
<h2>Constructor</h2>
5858

5959

60-
<h4 class="name" id="WebSocketClient"><span class="type-signature"></span>new WebSocketClient<span class="signature">(uri<span class="signature-attributes">opt</span>, id<span class="signature-attributes">opt</span>, serializer<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
60+
<h4 class="name" id="WebSocketClient"><span class="type-signature"></span>new WebSocketClient<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
6161

6262

6363

@@ -135,6 +135,60 @@ <h5>Parameters:</h5>
135135

136136

137137

138+
139+
<th class="last">Description</th>
140+
</tr>
141+
</thead>
142+
143+
<tbody>
144+
145+
146+
<tr>
147+
148+
<td class="name"><code>options</code></td>
149+
150+
151+
<td class="type">
152+
153+
154+
<span class="param-type">Object</span>
155+
156+
157+
158+
</td>
159+
160+
161+
<td class="attributes">
162+
163+
&lt;optional><br>
164+
165+
166+
167+
168+
169+
</td>
170+
171+
172+
173+
174+
<td class="description last"><p>options object</p>
175+
<h6>Properties</h6>
176+
177+
178+
<table class="params">
179+
<thead>
180+
<tr>
181+
182+
<th>Name</th>
183+
184+
185+
<th>Type</th>
186+
187+
188+
<th>Attributes</th>
189+
190+
191+
138192
<th>Default</th>
139193

140194

@@ -174,7 +228,7 @@ <h5>Parameters:</h5>
174228

175229
<td class="default">
176230

177-
<code>wss://localhost:9500</code>
231+
<code>ws://localhost:9500</code>
178232

179233
</td>
180234

@@ -370,6 +424,13 @@ <h6>Properties</h6>
370424
</tbody>
371425
</table>
372426

427+
</td>
428+
</tr>
429+
430+
431+
</tbody>
432+
</table>
433+
373434

374435

375436

@@ -414,7 +475,7 @@ <h4 class="name" id="blacklist"><span class="type-signature"></span>blacklist<sp
414475

415476
<dt class="tag-source">Source:</dt>
416477
<dd class="tag-source"><ul class="dummy"><li>
417-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line47">line 47</a>
478+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line48">line 48</a>
418479
</li></ul></dd>
419480

420481

@@ -525,7 +586,7 @@ <h4 class="name" id="client"><span class="type-signature"></span>client<span cla
525586

526587
<dt class="tag-source">Source:</dt>
527588
<dd class="tag-source"><ul class="dummy"><li>
528-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line79">line 79</a>
589+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line80">line 80</a>
529590
</li></ul></dd>
530591

531592

@@ -636,7 +697,7 @@ <h4 class="name" id="closed"><span class="type-signature"></span>closed<span cla
636697

637698
<dt class="tag-source">Source:</dt>
638699
<dd class="tag-source"><ul class="dummy"><li>
639-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line156">line 156</a>
700+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line157">line 157</a>
640701
</li></ul></dd>
641702

642703

@@ -747,7 +808,7 @@ <h4 class="name" id="closing"><span class="type-signature"></span>closing<span c
747808

748809
<dt class="tag-source">Source:</dt>
749810
<dd class="tag-source"><ul class="dummy"><li>
750-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line149">line 149</a>
811+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line150">line 150</a>
751812
</li></ul></dd>
752813

753814

@@ -858,7 +919,7 @@ <h4 class="name" id="connecting"><span class="type-signature"></span>connecting<
858919

859920
<dt class="tag-source">Source:</dt>
860921
<dd class="tag-source"><ul class="dummy"><li>
861-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line135">line 135</a>
922+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line136">line 136</a>
862923
</li></ul></dd>
863924

864925

@@ -969,7 +1030,7 @@ <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type
9691030

9701031
<dt class="tag-source">Source:</dt>
9711032
<dd class="tag-source"><ul class="dummy"><li>
972-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line43">line 43</a>
1033+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line44">line 44</a>
9731034
</li></ul></dd>
9741035

9751036

@@ -1080,7 +1141,7 @@ <h4 class="name" id="message"><span class="type-signature"></span>message<span c
10801141

10811142
<dt class="tag-source">Source:</dt>
10821143
<dd class="tag-source"><ul class="dummy"><li>
1083-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line75">line 75</a>
1144+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line76">line 76</a>
10841145
</li></ul></dd>
10851146

10861147

@@ -1191,7 +1252,7 @@ <h4 class="name" id="open"><span class="type-signature"></span>open<span class="
11911252

11921253
<dt class="tag-source">Source:</dt>
11931254
<dd class="tag-source"><ul class="dummy"><li>
1194-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line142">line 142</a>
1255+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line143">line 143</a>
11951256
</li></ul></dd>
11961257

11971258

@@ -1302,7 +1363,7 @@ <h4 class="name" id="subscribed"><span class="type-signature"></span>subscribed<
13021363

13031364
<dt class="tag-source">Source:</dt>
13041365
<dd class="tag-source"><ul class="dummy"><li>
1305-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line71">line 71</a>
1366+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line72">line 72</a>
13061367
</li></ul></dd>
13071368

13081369

@@ -1413,7 +1474,7 @@ <h4 class="name" id="uri"><span class="type-signature"></span>uri<span class="ty
14131474

14141475
<dt class="tag-source">Source:</dt>
14151476
<dd class="tag-source"><ul class="dummy"><li>
1416-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line65">line 65</a>
1477+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line66">line 66</a>
14171478
</li></ul></dd>
14181479

14191480

@@ -1534,7 +1595,7 @@ <h4 class="name" id="close"><span class="type-signature"></span>close<span class
15341595

15351596
<dt class="tag-source">Source:</dt>
15361597
<dd class="tag-source"><ul class="dummy"><li>
1537-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line182">line 182</a>
1598+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line183">line 183</a>
15381599
</li></ul></dd>
15391600

15401601

@@ -1636,7 +1697,7 @@ <h4 class="name" id="pub"><span class="type-signature"></span>pub<span class="si
16361697

16371698
<dt class="tag-source">Source:</dt>
16381699
<dd class="tag-source"><ul class="dummy"><li>
1639-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line168">line 168</a>
1700+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line169">line 169</a>
16401701
</li></ul></dd>
16411702

16421703

@@ -1875,7 +1936,7 @@ <h4 class="name" id="event:close">close</h4>
18751936

18761937
<dt class="tag-source">Source:</dt>
18771938
<dd class="tag-source"><ul class="dummy"><li>
1878-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line91">line 91</a>
1939+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line92">line 92</a>
18791940
</li></ul></dd>
18801941

18811942

@@ -1959,7 +2020,7 @@ <h4 class="name" id="event:connect">connect</h4>
19592020

19602021
<dt class="tag-source">Source:</dt>
19612022
<dd class="tag-source"><ul class="dummy"><li>
1962-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line96">line 96</a>
2023+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line97">line 97</a>
19632024
</li></ul></dd>
19642025

19652026

@@ -2053,7 +2114,7 @@ <h4 class="name" id="event:ready">ready</h4>
20532114

20542115
<dt class="tag-source">Source:</dt>
20552116
<dd class="tag-source"><ul class="dummy"><li>
2056-
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line83">line 83</a>
2117+
<a href="lib_websocket_client.js.html">lib/websocket/client.js</a>, <a href="lib_websocket_client.js.html#line84">line 84</a>
20572118
</li></ul></dd>
20582119

20592120

@@ -2134,7 +2195,7 @@ <h4 class="name" id="event:ready">ready</h4>
21342195
<br class="clear">
21352196

21362197
<footer>
2137-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 00:09:30 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
2198+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Jan 27 2017 14:15:50 GMT-0800 (PST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
21382199
</footer>
21392200

21402201
<script>prettyPrint();</script>

0 commit comments

Comments
 (0)