1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 |
|
5 | <meta charset="utf-8">
|
6 | <title>StreamClient - Documentation</title>
|
7 |
|
8 | <meta name="description" content="Implementation of the v2 twitter streaming api" />
|
9 |
|
10 | <meta name="keywords" content="twitter api v2 node.js rest http stream client" />
|
11 | <meta name="keyword" content="twitter api v2 node.js rest http stream client" />
|
12 |
|
13 |
|
14 |
|
15 | <script src="scripts/prettify/prettify.js"></script>
|
16 | <script src="scripts/prettify/lang-css.js"></script>
|
17 | |
18 |
|
19 |
|
20 | <link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
21 | <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
22 | <script src="scripts/nav.js" defer></script>
|
23 | <meta name="viewport" content="width=device-width, initial-scale=1.0">
|
24 | </head>
|
25 | <body>
|
26 |
|
27 | <input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
28 | <label for="nav-trigger" class="navicon-button x">
|
29 | <div class="navicon"></div>
|
30 | </label>
|
31 |
|
32 | <label for="nav-trigger" class="overlay"></label>
|
33 |
|
34 | <nav >
|
35 |
|
36 | <input type="text" id="nav-search" placeholder="Search" />
|
37 |
|
38 | <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/CrunchwrapSupreme/twit-stream-v2" target="_blank" class="menu-item" id="website_link" >Github Repo</a></h2><h3>Classes</h3><ul><li><a href="StreamClient.html">StreamClient</a><ul class='methods'><li data-type='method'><a href="StreamClient.html#connect">connect</a></li><li data-type='method'><a href="StreamClient.html#disconnect">disconnect</a></li></ul></li></ul><h3>Events</h3><ul><li><a href="StreamClient.html#event:tweet">tweet</a></li><li><a href="StreamClient.html#event:heartbeat">heartbeat</a></li><li><a href="StreamClient.html#event:stream-error">stream-error</a></li><li><a href="StreamClient.html#event:api-errors">api-errors</a></li><li><a href="StreamClient.html#event:other">other</a></li><li><a href="StreamClient.html#event:connected">connected</a></li><li><a href="StreamClient.html#event:reconnect">reconnect</a></li><li><a href="StreamClient.html#event:disconnected">disconnected</a></li><li><a href="StreamClient.html#event:close">close</a></li></ul>
|
39 | </nav>
|
40 |
|
41 | <div id="main">
|
42 |
|
43 | <h1 class="page-title">StreamClient</h1>
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 | <section>
|
52 |
|
53 | <header>
|
54 |
|
55 | <h2>
|
56 | StreamClient
|
57 | </h2>
|
58 |
|
59 | <div class="class-description usertext"><p>Connect to the Twitter API v2 sampled stream endpoint and emit events for processing<br/>
|
60 | For additional information see
|
61 | <a href="https://developer.twitter.com/en/docs/twitter-api/tweets/sampled-stream/introduction">Twitter Sampled Stream</a></p></div>
|
62 |
|
63 |
|
64 | </header>
|
65 |
|
66 | <article>
|
67 |
|
68 | <div class="container-overview">
|
69 |
|
70 |
|
71 |
|
72 |
|
73 | <h2>Constructor</h2>
|
74 |
|
75 |
|
76 | <h4 class="name" id="StreamClient"><span class="type-signature"></span>new StreamClient<span class="signature">(config)</span><span class="type-signature"></span></h4>
|
77 |
|
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 | <dl class="details">
|
84 |
|
85 |
|
86 | <dt class="tag-source">Source:</dt>
|
87 | <dd class="tag-source"><ul class="dummy"><li>
|
88 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line92">line 92</a>
|
89 | </li></ul></dd>
|
90 |
|
91 |
|
92 |
|
93 |
|
94 |
|
95 |
|
96 |
|
97 |
|
98 |
|
99 |
|
100 |
|
101 |
|
102 |
|
103 |
|
104 |
|
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 | </dl>
|
122 |
|
123 |
|
124 |
|
125 |
|
126 |
|
127 | <div class="description usertext">
|
128 | <p>Initializes the client</p>
|
129 | </div>
|
130 |
|
131 |
|
132 |
|
133 |
|
134 |
|
135 |
|
136 |
|
137 |
|
138 |
|
139 |
|
140 |
|
141 | <h5>Parameters:</h5>
|
142 |
|
143 |
|
144 | <table class="params">
|
145 | <thead>
|
146 | <tr>
|
147 |
|
148 | <th>Name</th>
|
149 |
|
150 |
|
151 | <th>Type</th>
|
152 |
|
153 |
|
154 |
|
155 |
|
156 |
|
157 | <th class="last">Description</th>
|
158 | </tr>
|
159 | </thead>
|
160 |
|
161 | <tbody>
|
162 |
|
163 |
|
164 | <tr>
|
165 |
|
166 | <td class="name"><code>config</code></td>
|
167 |
|
168 |
|
169 | <td class="type">
|
170 |
|
171 |
|
172 | <span class="param-type">Object</span>
|
173 |
|
174 |
|
175 |
|
176 | </td>
|
177 |
|
178 |
|
179 |
|
180 |
|
181 |
|
182 | <td class="description last"><p>Configuration for client</p>
|
183 | <h6>Properties</h6>
|
184 |
|
185 |
|
186 | <table class="params">
|
187 | <thead>
|
188 | <tr>
|
189 |
|
190 | <th>Name</th>
|
191 |
|
192 |
|
193 | <th>Type</th>
|
194 |
|
195 |
|
196 |
|
197 |
|
198 |
|
199 | <th class="last">Description</th>
|
200 | </tr>
|
201 | </thead>
|
202 |
|
203 | <tbody>
|
204 |
|
205 |
|
206 | <tr>
|
207 |
|
208 | <td class="name"><code>timeout</code></td>
|
209 |
|
210 |
|
211 | <td class="type">
|
212 |
|
213 |
|
214 | <span class="param-type">number</span>
|
215 |
|
216 |
|
217 |
|
218 | </td>
|
219 |
|
220 |
|
221 |
|
222 |
|
223 |
|
224 | <td class="description last"><p>Set request and response timeout</p></td>
|
225 | </tr>
|
226 |
|
227 |
|
228 |
|
229 | <tr>
|
230 |
|
231 | <td class="name"><code>token</code></td>
|
232 |
|
233 |
|
234 | <td class="type">
|
235 |
|
236 |
|
237 | <span class="param-type">string</span>
|
238 |
|
239 |
|
240 |
|
241 | </td>
|
242 |
|
243 |
|
244 |
|
245 |
|
246 |
|
247 | <td class="description last"><p>Set <a href="https://developer.twitter.com/en/docs/authentication/oauth-2-0">OAUTH Bearer token</a> from developer account</p></td>
|
248 | </tr>
|
249 |
|
250 |
|
251 | </tbody>
|
252 | </table>
|
253 |
|
254 | </td>
|
255 | </tr>
|
256 |
|
257 |
|
258 | </tbody>
|
259 | </table>
|
260 |
|
261 |
|
262 |
|
263 |
|
264 |
|
265 |
|
266 | <h5>Fires:</h5>
|
267 | <ul>
|
268 | <li><a href="StreamClient.html#event:tweet">StreamClient#event:tweet</a></li>
|
269 |
|
270 | <li><a href="StreamClient.html#event:connected">StreamClient#event:connected</a></li>
|
271 |
|
272 | <li><a href="StreamClient.html#event:reconnect">StreamClient#event:reconnect</a></li>
|
273 |
|
274 | <li><a href="StreamClient.html#event:disconnected">StreamClient#event:disconnected</a></li>
|
275 |
|
276 | <li><a href="StreamClient.html#event:close">StreamClient#event:close</a></li>
|
277 |
|
278 | <li><a href="StreamClient.html#event:stream-error">StreamClient#event:stream-error</a></li>
|
279 |
|
280 | <li><a href="StreamClient.html#event:api-errors">StreamClient#event:api-errors</a></li>
|
281 |
|
282 | <li><a href="StreamClient.html#event:heartbeat">StreamClient#event:heartbeat</a></li>
|
283 |
|
284 | <li><a href="StreamClient.html#event:other">StreamClient#event:other</a></li>
|
285 | </ul>
|
286 |
|
287 |
|
288 |
|
289 |
|
290 |
|
291 |
|
292 |
|
293 |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 |
|
299 |
|
300 |
|
301 | </div>
|
302 |
|
303 |
|
304 |
|
305 | <h3 class="subsection-title">Extends</h3>
|
306 |
|
307 |
|
308 |
|
309 |
|
310 | <ul>
|
311 | <li>EventEmitter</li>
|
312 | </ul>
|
313 |
|
314 |
|
315 |
|
316 |
|
317 |
|
318 |
|
319 |
|
320 |
|
321 |
|
322 |
|
323 |
|
324 |
|
325 |
|
326 |
|
327 |
|
328 |
|
329 |
|
330 | <h3 class="subsection-title">Methods</h3>
|
331 |
|
332 |
|
333 |
|
334 |
|
335 |
|
336 |
|
337 | <h4 class="name" id="connect"><span class="type-signature">(async) </span>connect<span class="signature">(config)</span><span class="type-signature"> → {Promise.<object>|Promise.<Error>}</span></h4>
|
338 |
|
339 |
|
340 |
|
341 |
|
342 |
|
343 |
|
344 | <dl class="details">
|
345 |
|
346 |
|
347 | <dt class="tag-source">Source:</dt>
|
348 | <dd class="tag-source"><ul class="dummy"><li>
|
349 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line120">line 120</a>
|
350 | </li></ul></dd>
|
351 |
|
352 |
|
353 |
|
354 |
|
355 |
|
356 |
|
357 |
|
358 |
|
359 |
|
360 |
|
361 |
|
362 |
|
363 |
|
364 |
|
365 |
|
366 |
|
367 |
|
368 |
|
369 |
|
370 |
|
371 |
|
372 |
|
373 |
|
374 |
|
375 |
|
376 |
|
377 |
|
378 |
|
379 |
|
380 | <dt class="tag-see">See:</dt>
|
381 | <dd class="tag-see">
|
382 | <ul>
|
383 | <li>retriableStatus</li>
|
384 | </ul>
|
385 | </dd>
|
386 |
|
387 |
|
388 |
|
389 | </dl>
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
|
395 | <div class="description usertext">
|
396 | <p>Connect to twitter stream and emit events.</p>
|
397 | </div>
|
398 |
|
399 |
|
400 |
|
401 |
|
402 |
|
403 |
|
404 |
|
405 |
|
406 |
|
407 |
|
408 |
|
409 | <h5>Parameters:</h5>
|
410 |
|
411 |
|
412 | <table class="params">
|
413 | <thead>
|
414 | <tr>
|
415 |
|
416 | <th>Name</th>
|
417 |
|
418 |
|
419 | <th>Type</th>
|
420 |
|
421 |
|
422 |
|
423 |
|
424 |
|
425 | <th class="last">Description</th>
|
426 | </tr>
|
427 | </thead>
|
428 |
|
429 | <tbody>
|
430 |
|
431 |
|
432 | <tr>
|
433 |
|
434 | <td class="name"><code>config</code></td>
|
435 |
|
436 |
|
437 | <td class="type">
|
438 |
|
439 |
|
440 | <span class="param-type">Object</span>
|
441 |
|
442 |
|
443 |
|
444 | </td>
|
445 |
|
446 |
|
447 |
|
448 |
|
449 |
|
450 | <td class="description last"><p>Configuration for connection</p>
|
451 | <h6>Properties</h6>
|
452 |
|
453 |
|
454 | <table class="params">
|
455 | <thead>
|
456 | <tr>
|
457 |
|
458 | <th>Name</th>
|
459 |
|
460 |
|
461 | <th>Type</th>
|
462 |
|
463 |
|
464 |
|
465 |
|
466 |
|
467 | <th class="last">Description</th>
|
468 | </tr>
|
469 | </thead>
|
470 |
|
471 | <tbody>
|
472 |
|
473 |
|
474 | <tr>
|
475 |
|
476 | <td class="name"><code>params</code></td>
|
477 |
|
478 |
|
479 | <td class="type">
|
480 |
|
481 |
|
482 | <span class="param-type">number</span>
|
483 |
|
484 |
|
485 |
|
486 | </td>
|
487 |
|
488 |
|
489 |
|
490 |
|
491 |
|
492 | <td class="description last"><p>Set any filter parameters for stream, etc.</p></td>
|
493 | </tr>
|
494 |
|
495 |
|
496 |
|
497 | <tr>
|
498 |
|
499 | <td class="name"><code>max_reconnects</code></td>
|
500 |
|
501 |
|
502 | <td class="type">
|
503 |
|
504 |
|
505 | <span class="param-type">string</span>
|
506 |
|
507 |
|
508 |
|
509 | </td>
|
510 |
|
511 |
|
512 |
|
513 |
|
514 |
|
515 | <td class="description last"><p>Specify max number of reconnects. Default: -1 (infinity)</p></td>
|
516 | </tr>
|
517 |
|
518 |
|
519 | </tbody>
|
520 | </table>
|
521 |
|
522 | </td>
|
523 | </tr>
|
524 |
|
525 |
|
526 | </tbody>
|
527 | </table>
|
528 |
|
529 |
|
530 |
|
531 |
|
532 |
|
533 |
|
534 |
|
535 |
|
536 |
|
537 |
|
538 |
|
539 |
|
540 |
|
541 |
|
542 |
|
543 |
|
544 | <h5>Returns:</h5>
|
545 |
|
546 |
|
547 | <div class="param-desc">
|
548 | <p>Promise that resolves on <a href="StreamClient.html#disconnect">disconnect</a>
|
549 | -- the Promise rejects if the number of reconnects exceeds the max or an irrecoverable error occurs
|
550 | -- the Promise resolves with that last error returned. Error object defines .reconnects if reconnects are exceeded</p>
|
551 | </div>
|
552 |
|
553 |
|
554 |
|
555 | <dl class="param-type">
|
556 | <dt>
|
557 | Type
|
558 | </dt>
|
559 | <dd>
|
560 |
|
561 | <span class="param-type">Promise.<object></span>
|
562 | |
|
563 |
|
564 | <span class="param-type">Promise.<Error></span>
|
565 |
|
566 |
|
567 | </dd>
|
568 | </dl>
|
569 |
|
570 |
|
571 |
|
572 |
|
573 |
|
574 |
|
575 |
|
576 |
|
577 |
|
578 |
|
579 | <h4 class="name" id="disconnect"><span class="type-signature"></span>disconnect<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
|
580 |
|
581 |
|
582 |
|
583 |
|
584 |
|
585 |
|
586 | <dl class="details">
|
587 |
|
588 |
|
589 | <dt class="tag-source">Source:</dt>
|
590 | <dd class="tag-source"><ul class="dummy"><li>
|
591 | <a href="index.js.html">index.js</a>, <a href="index.js.html#line167">line 167</a>
|
592 | </li></ul></dd>
|
593 |
|
594 |
|
595 |
|
596 |
|
597 |
|
598 |
|
599 |
|
600 |
|
601 |
|
602 |
|
603 |
|
604 |
|
605 |
|
606 |
|
607 |
|
608 |
|
609 |
|
610 |
|
611 |
|
612 |
|
613 |
|
614 |
|
615 |
|
616 |
|
617 |
|
618 |
|
619 |
|
620 |
|
621 |
|
622 |
|
623 |
|
624 | </dl>
|
625 |
|
626 |
|
627 |
|
628 |
|
629 |
|
630 | <div class="description usertext">
|
631 | <p>Disconnects an active request if any</p>
|
632 | </div>
|
633 |
|
634 |
|
635 |
|
636 |
|
637 |
|
638 |
|
639 |
|
640 |
|
641 |
|
642 |
|
643 |
|
644 |
|
645 |
|
646 |
|
647 |
|
648 |
|
649 |
|
650 |
|
651 |
|
652 |
|
653 |
|
654 |
|
655 |
|
656 |
|
657 |
|
658 | <h5>Returns:</h5>
|
659 |
|
660 |
|
661 | <div class="param-desc">
|
662 | <p>Returns true if there is a request to disconnect</p>
|
663 | </div>
|
664 |
|
665 |
|
666 |
|
667 | <dl class="param-type">
|
668 | <dt>
|
669 | Type
|
670 | </dt>
|
671 | <dd>
|
672 |
|
673 | <span class="param-type">boolean</span>
|
674 |
|
675 |
|
676 | </dd>
|
677 | </dl>
|
678 |
|
679 |
|
680 |
|
681 |
|
682 |
|
683 |
|
684 |
|
685 |
|
686 |
|
687 |
|
688 |
|
689 | <h3 class="subsection-title">Events</h3>
|
690 |
|
691 |
|
692 |
|
693 |
|
694 |
|
695 |
|
696 | <h4 class="name" id="event:tweet">tweet</h4>
|
697 |
|
698 |
|
699 |
|
700 |
|
701 |
|
702 |
|
703 | <dl class="details">
|
704 |
|
705 |
|
706 | <dt class="tag-source">Source:</dt>
|
707 | <dd class="tag-source"><ul class="dummy"><li>
|
708 | <a href="lib_events.jsdoc.html">lib/events.jsdoc</a>, <a href="lib_events.jsdoc.html#line1">line 1</a>
|
709 | </li></ul></dd>
|
710 |
|
711 |
|
712 |
|
713 |
|
714 |
|
715 |
|
716 |
|
717 |
|
718 |
|
719 |
|
720 |
|
721 |
|
722 |
|
723 |
|
724 |
|
725 |
|
726 |
|
727 |
|
728 |
|
729 |
|
730 |
|
731 |
|
732 |
|
733 |
|
734 |
|
735 |
|
736 |
|
737 |
|
738 |
|
739 |
|
740 |
|
741 | </dl>
|
742 |
|
743 |
|
744 |
|
745 |
|
746 |
|
747 | <div class="description usertext">
|
748 | <p>Triggered upon connected stream receiving a tweet</p>
|
749 | </div>
|
750 |
|
751 |
|
752 |
|
753 |
|
754 |
|
755 | <h5>Type:</h5>
|
756 | <ul>
|
757 | <li>
|
758 |
|
759 | <span class="param-type">Object</span>
|
760 |
|
761 |
|
762 | </li>
|
763 | </ul>
|
764 |
|
765 |
|
766 |
|
767 |
|
768 |
|
769 |
|
770 |
|
771 |
|
772 |
|
773 |
|
774 |
|
775 |
|
776 |
|
777 |
|
778 |
|
779 |
|
780 |
|
781 |
|
782 |
|
783 |
|
784 |
|
785 |
|
786 |
|
787 |
|
788 |
|
789 |
|
790 |
|
791 |
|
792 |
|
793 | <h4 class="name" id="event:heartbeat">heartbeat</h4>
|
794 |
|
795 |
|
796 |
|
797 |
|
798 |
|
799 |
|
800 | <dl class="details">
|
801 |
|
802 |
|
803 | <dt class="tag-source">Source:</dt>
|
804 | <dd class="tag-source"><ul class="dummy"><li>
|
805 | <a href="lib_events.jsdoc.html">lib/events.jsdoc</a>, <a href="lib_events.jsdoc.html#line7">line 7</a>
|
806 | </li></ul></dd>
|
807 |
|
808 |
|
809 |
|
810 |
|
811 |
|
812 |
|
813 |
|
814 |
|
815 |
|
816 |
|
817 |
|
818 |
|
819 |
|
820 |
|
821 |
|
822 |
|
823 |
|
824 |
|
825 |
|
826 |
|
827 |
|
828 |
|
829 |
|
830 |
|
831 |
|
832 |
|
833 |
|
834 |
|
835 |
|
836 |
|
837 |
|
838 | </dl>
|
839 |
|
840 |
|
841 |
|
842 |
|
843 |
|
844 | <div class="description usertext">
|
845 | <p>Triggered upon connected stream receiving a heartbeat</p>
|
846 | </div>
|
847 |
|
848 |
|
849 |
|
850 |
|
851 |
|
852 |
|
853 |
|
854 |
|
855 |
|
856 |
|
857 |
|
858 |
|
859 |
|
860 |
|
861 |
|
862 |
|
863 |
|
864 |
|
865 |
|
866 |
|
867 |
|
868 |
|
869 |
|
870 |
|
871 |
|
872 |
|
873 |
|
874 |
|
875 |
|
876 |
|
877 |
|
878 |
|
879 |
|
880 | <h4 class="name" id="event:stream-error">stream-error</h4>
|
881 |
|
882 |
|
883 |
|
884 |
|
885 |
|
886 |
|
887 | <dl class="details">
|
888 |
|
889 |
|
890 | <dt class="tag-source">Source:</dt>
|
891 | <dd class="tag-source"><ul class="dummy"><li>
|
892 | <a href="lib_events.jsdoc.html">lib/events.jsdoc</a>, <a href="lib_events.jsdoc.html#line12">line 12</a>
|
893 | </li></ul></dd>
|
894 |
|
895 |
|
896 |
|
897 |
|
898 |
|
899 |
|
900 |
|
901 |
|
902 |
|
903 |
|
904 |
|
905 |
|
906 |
|
907 |
|
908 |
|
909 |
|
910 |
|
911 |
|
912 |
|
913 |
|
914 |
|
915 |
|
916 |
|
917 |
|
918 |
|
919 |
|
920 |
|
921 |
|
922 |
|
923 |
|
924 |
|
925 | </dl>
|
926 |
|
927 |
|
928 |
|
929 |
|
930 |
|
931 | <div class="description usertext">
|
932 | <p>Triggered when on api-level stream errors (misformatted JSON, etc.)</p>
|
933 | </div>
|
934 |
|
935 |
|
936 |
|
937 |
|
938 |
|
939 | <h5>Type:</h5>
|
940 | <ul>
|
941 | <li>
|
942 |
|
943 | <span class="param-type">Object</span>
|
944 |
|
945 |
|
946 | </li>
|
947 | </ul>
|
948 |
|
949 |
|
950 |
|
951 |
|
952 |
|
953 |
|
954 |
|
955 |
|
956 |
|
957 |
|
958 |
|
959 |
|
960 |
|
961 |
|
962 |
|
963 |
|
964 |
|
965 |
|
966 |
|
967 |
|
968 |
|
969 |
|
970 |
|
971 |
|
972 |
|
973 |
|
974 |
|
975 |
|
976 |
|
977 | <h4 class="name" id="event:api-errors">api-errors</h4>
|
978 |
|
979 |
|
980 |
|
981 |
|
982 |
|
983 |
|
984 | <dl class="details">
|
985 |
|
986 |
|
987 | <dt class="tag-source">Source:</dt>
|
988 | <dd class="tag-source"><ul class="dummy"><li>
|
989 | <a href="lib_events.jsdoc.html">lib/events.jsdoc</a>, <a href="lib_events.jsdoc.html#line18">line 18</a>
|
990 | </li></ul></dd>
|
991 |
|
992 |
|
993 |
|
994 |
|
995 |
|
996 |
|
997 |
|
998 |
|
999 |
|
1000 |
|
1001 |
|
1002 |
|
1003 |
|
1004 |
|
1005 |
|
1006 |
|
1007 |
|
1008 |
|
1009 |
|
1010 |
|
1011 |
|
1012 |
|
1013 |
|
1014 |
|
1015 |
|
1016 |
|
1017 |
|
1018 |
|
1019 |
|
1020 |
|
1021 |
|
1022 | </dl>
|
1023 |
|
1024 |
|
1025 |
|
1026 |
|
1027 |
|
1028 | <div class="description usertext">
|
1029 | <p>Provides twitter error messages as JSON objects</p>
|
1030 | </div>
|
1031 |
|
1032 |
|
1033 |
|
1034 |
|
1035 |
|
1036 | <h5>Type:</h5>
|
1037 | <ul>
|
1038 | <li>
|
1039 |
|
1040 | <span class="param-type">Object</span>
|
1041 |
|
1042 |
|
1043 | </li>
|
1044 | </ul>
|
1045 |
|
1046 |
|
1047 |
|
1048 |
|
1049 |
|
1050 |
|
1051 |
|
1052 |
|
1053 |
|
1054 |
|
1055 |
|
1056 |
|
1057 |
|
1058 |
|
1059 |
|
1060 |
|
1061 |
|
1062 |
|
1063 |
|
1064 |
|
1065 |
|
1066 |
|
1067 |
|
1068 |
|
1069 |
|
1070 |
|
1071 |
|
1072 |
|
1073 |
|
1074 | <h4 class="name" id="event:other">other</h4>
|
1075 |
|
1076 |
|
1077 |
|
1078 |
|
1079 |
|
1080 |
|
1081 | <dl class="details">
|
1082 |
|
1083 |
|
1084 | <dt class="tag-source">Source:</dt>
|
1085 | <dd class="tag-source"><ul class="dummy"><li>
|
1086 | <a href="lib_events.jsdoc.html">lib/events.jsdoc</a>, <a href="lib_events.jsdoc.html#line24">line 24</a>
|
1087 | </li></ul></dd>
|
1088 |
|
1089 |
|
1090 |
|
1091 |
|
1092 |
|
1093 |
|
1094 |
|
1095 |
|
1096 |
|
1097 |
|
1098 |
|
1099 |
|
1100 |
|
1101 |
|
1102 |
|
1103 |
|
1104 |
|
1105 |
|
1106 |
|
1107 |
|
1108 |
|
1109 |
|
1110 |
|
1111 |
|
1112 |
|
1113 |
|
1114 |
|
1115 |
|
1116 |
|
1117 |
|
1118 |
|
1119 | </dl>
|
1120 |
|
1121 |
|
1122 |
|
1123 |
|
1124 |
|
1125 | <div class="description usertext">
|
1126 | <p>Triggered upon connected stream receiving unexpected JSON</p>
|
1127 | </div>
|
1128 |
|
1129 |
|
1130 |
|
1131 |
|
1132 |
|
1133 | <h5>Type:</h5>
|
1134 | <ul>
|
1135 | <li>
|
1136 |
|
1137 | <span class="param-type">Object</span>
|
1138 |
|
1139 |
|
1140 | </li>
|
1141 | </ul>
|
1142 |
|
1143 |
|
1144 |
|
1145 |
|
1146 |
|
1147 |
|
1148 |
|
1149 |
|
1150 |
|
1151 |
|
1152 |
|
1153 |
|
1154 |
|
1155 |
|
1156 |
|
1157 |
|
1158 |
|
1159 |
|
1160 |
|
1161 |
|
1162 |
|
1163 |
|
1164 |
|
1165 |
|
1166 |
|
1167 |
|
1168 |
|
1169 |
|
1170 |
|
1171 | <h4 class="name" id="event:connected">connected</h4>
|
1172 |
|
1173 |
|
1174 |
|
1175 |
|
1176 |
|
1177 |
|
1178 | <dl class="details">
|
1179 |
|
1180 |
|
1181 | <dt class="tag-source">Source:</dt>
|
1182 | <dd class="tag-source"><ul class="dummy"><li>
|
1183 | <a href="lib_events.jsdoc.html">lib/events.jsdoc</a>, <a href="lib_events.jsdoc.html#line30">line 30</a>
|
1184 | </li></ul></dd>
|
1185 |
|
1186 |
|
1187 |
|
1188 |
|
1189 |
|
1190 |
|
1191 |
|
1192 |
|
1193 |
|
1194 |
|
1195 |
|
1196 |
|
1197 |
|
1198 |
|
1199 |
|
1200 |
|
1201 |
|
1202 |
|
1203 |
|
1204 |
|
1205 |
|
1206 |
|
1207 |
|
1208 |
|
1209 |
|
1210 |
|
1211 |
|
1212 |
|
1213 |
|
1214 |
|
1215 |
|
1216 | </dl>
|
1217 |
|
1218 |
|
1219 |
|
1220 |
|
1221 |
|
1222 | <div class="description usertext">
|
1223 | <p>Triggered on stream connection</p>
|
1224 | </div>
|
1225 |
|
1226 |
|
1227 |
|
1228 |
|
1229 |
|
1230 |
|
1231 |
|
1232 |
|
1233 |
|
1234 |
|
1235 |
|
1236 |
|
1237 |
|
1238 |
|
1239 |
|
1240 |
|
1241 |
|
1242 |
|
1243 |
|
1244 |
|
1245 |
|
1246 |
|
1247 |
|
1248 |
|
1249 |
|
1250 |
|
1251 |
|
1252 |
|
1253 |
|
1254 |
|
1255 |
|
1256 |
|
1257 |
|
1258 | <h4 class="name" id="event:reconnect">reconnect</h4>
|
1259 |
|
1260 |
|
1261 |
|
1262 |
|
1263 |
|
1264 |
|
1265 | <dl class="details">
|
1266 |
|
1267 |
|
1268 | <dt class="tag-source">Source:</dt>
|
1269 | <dd class="tag-source"><ul class="dummy"><li>
|
1270 | <a href="lib_events.jsdoc.html">lib/events.jsdoc</a>, <a href="lib_events.jsdoc.html#line35">line 35</a>
|
1271 | </li></ul></dd>
|
1272 |
|
1273 |
|
1274 |
|
1275 |
|
1276 |
|
1277 |
|
1278 |
|
1279 |
|
1280 |
|
1281 |
|
1282 |
|
1283 |
|
1284 |
|
1285 |
|
1286 |
|
1287 |
|
1288 |
|
1289 |
|
1290 |
|
1291 |
|
1292 |
|
1293 |
|
1294 |
|
1295 |
|
1296 |
|
1297 |
|
1298 |
|
1299 |
|
1300 |
|
1301 |
|
1302 |
|
1303 | </dl>
|
1304 |
|
1305 |
|
1306 |
|
1307 |
|
1308 |
|
1309 | <div class="description usertext">
|
1310 | <p>Triggered before stream reconnect and provides the wait time till reconnect</p>
|
1311 | </div>
|
1312 |
|
1313 |
|
1314 |
|
1315 |
|
1316 |
|
1317 | <h5>Type:</h5>
|
1318 | <ul>
|
1319 | <li>
|
1320 |
|
1321 | <span class="param-type">number</span>
|
1322 |
|
1323 |
|
1324 | </li>
|
1325 | </ul>
|
1326 |
|
1327 |
|
1328 |
|
1329 |
|
1330 |
|
1331 |
|
1332 |
|
1333 |
|
1334 |
|
1335 |
|
1336 |
|
1337 |
|
1338 |
|
1339 |
|
1340 |
|
1341 |
|
1342 |
|
1343 |
|
1344 |
|
1345 |
|
1346 |
|
1347 |
|
1348 |
|
1349 |
|
1350 |
|
1351 |
|
1352 |
|
1353 |
|
1354 |
|
1355 | <h4 class="name" id="event:disconnected">disconnected</h4>
|
1356 |
|
1357 |
|
1358 |
|
1359 |
|
1360 |
|
1361 |
|
1362 | <dl class="details">
|
1363 |
|
1364 |
|
1365 | <dt class="tag-source">Source:</dt>
|
1366 | <dd class="tag-source"><ul class="dummy"><li>
|
1367 | <a href="lib_events.jsdoc.html">lib/events.jsdoc</a>, <a href="lib_events.jsdoc.html#line41">line 41</a>
|
1368 | </li></ul></dd>
|
1369 |
|
1370 |
|
1371 |
|
1372 |
|
1373 |
|
1374 |
|
1375 |
|
1376 |
|
1377 |
|
1378 |
|
1379 |
|
1380 |
|
1381 |
|
1382 |
|
1383 |
|
1384 |
|
1385 |
|
1386 |
|
1387 |
|
1388 |
|
1389 |
|
1390 |
|
1391 |
|
1392 |
|
1393 |
|
1394 |
|
1395 |
|
1396 |
|
1397 |
|
1398 |
|
1399 |
|
1400 | </dl>
|
1401 |
|
1402 |
|
1403 |
|
1404 |
|
1405 |
|
1406 | <div class="description usertext">
|
1407 | <p>Triggered when manually disconnecting client stream</p>
|
1408 | </div>
|
1409 |
|
1410 |
|
1411 |
|
1412 |
|
1413 |
|
1414 |
|
1415 |
|
1416 |
|
1417 |
|
1418 |
|
1419 |
|
1420 |
|
1421 |
|
1422 |
|
1423 |
|
1424 |
|
1425 |
|
1426 |
|
1427 |
|
1428 |
|
1429 |
|
1430 |
|
1431 |
|
1432 |
|
1433 |
|
1434 |
|
1435 |
|
1436 |
|
1437 |
|
1438 |
|
1439 |
|
1440 |
|
1441 |
|
1442 | <h4 class="name" id="event:close">close</h4>
|
1443 |
|
1444 |
|
1445 |
|
1446 |
|
1447 |
|
1448 |
|
1449 | <dl class="details">
|
1450 |
|
1451 |
|
1452 | <dt class="tag-source">Source:</dt>
|
1453 | <dd class="tag-source"><ul class="dummy"><li>
|
1454 | <a href="lib_events.jsdoc.html">lib/events.jsdoc</a>, <a href="lib_events.jsdoc.html#line46">line 46</a>
|
1455 | </li></ul></dd>
|
1456 |
|
1457 |
|
1458 |
|
1459 |
|
1460 |
|
1461 |
|
1462 |
|
1463 |
|
1464 |
|
1465 |
|
1466 |
|
1467 |
|
1468 |
|
1469 |
|
1470 |
|
1471 |
|
1472 |
|
1473 |
|
1474 |
|
1475 |
|
1476 |
|
1477 |
|
1478 |
|
1479 |
|
1480 |
|
1481 |
|
1482 |
|
1483 |
|
1484 |
|
1485 |
|
1486 |
|
1487 | </dl>
|
1488 |
|
1489 |
|
1490 |
|
1491 |
|
1492 |
|
1493 | <div class="description usertext">
|
1494 | <p>Triggered upon stream close</p>
|
1495 | </div>
|
1496 |
|
1497 |
|
1498 |
|
1499 |
|
1500 |
|
1501 |
|
1502 |
|
1503 |
|
1504 |
|
1505 |
|
1506 |
|
1507 |
|
1508 |
|
1509 |
|
1510 |
|
1511 |
|
1512 |
|
1513 |
|
1514 |
|
1515 |
|
1516 |
|
1517 |
|
1518 |
|
1519 |
|
1520 |
|
1521 |
|
1522 |
|
1523 |
|
1524 |
|
1525 |
|
1526 | </article>
|
1527 |
|
1528 | </section>
|
1529 |
|
1530 |
|
1531 |
|
1532 |
|
1533 |
|
1534 |
|
1535 | </div>
|
1536 |
|
1537 | <br class="clear">
|
1538 |
|
1539 | <footer>
|
1540 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Mon Oct 19 2020 05:12:10 GMT-0500 (Central Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
1541 | </footer>
|
1542 |
|
1543 | <script>prettyPrint();</script>
|
1544 | <script src="scripts/polyfill.js"></script>
|
1545 | <script src="scripts/linenumber.js"></script>
|
1546 |
|
1547 | <script src="scripts/search.js" defer></script>
|
1548 |
|
1549 |
|
1550 |
|
1551 | </body>
|
1552 | </html> |
\ | No newline at end of file |