1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 |
|
5 | <meta charset="utf-8">
|
6 | <title>lib/events.jsdoc - 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">lib/events.jsdoc</h1>
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 | <section>
|
52 | <article>
|
53 | <pre class="prettyprint source linenums"><code>/**
|
54 | * Triggered upon connected stream receiving a tweet
|
55 | * @type {Object}
|
56 | * @event StreamClient#tweet
|
57 | */
|
58 |
|
59 | /**
|
60 | * Triggered upon connected stream receiving a heartbeat
|
61 | * @event StreamClient#heartbeat
|
62 | */
|
63 |
|
64 | /**
|
65 | * Triggered when on api-level stream errors (misformatted JSON, etc.)
|
66 | * @type {Object}
|
67 | * @event StreamClient#stream-error
|
68 | */
|
69 |
|
70 | /**
|
71 | * Provides twitter error messages as JSON objects
|
72 | * @type {Object}
|
73 | * @event StreamClient#api-errors
|
74 | */
|
75 |
|
76 | /**
|
77 | * Triggered upon connected stream receiving unexpected JSON
|
78 | * @type {Object}
|
79 | * @event StreamClient#other
|
80 | */
|
81 |
|
82 | /**
|
83 | * Triggered on stream connection
|
84 | * @event StreamClient#connected
|
85 | */
|
86 |
|
87 | /**
|
88 | * Triggered before stream reconnect and provides the wait time till reconnect
|
89 | * @type {number}
|
90 | * @event StreamClient#reconnect
|
91 | */
|
92 |
|
93 | /**
|
94 | * Triggered when manually disconnecting client stream
|
95 | * @event StreamClient#disconnected
|
96 | */
|
97 |
|
98 | /**
|
99 | * Triggered upon stream close
|
100 | * @event StreamClient#close
|
101 | */</code></pre>
|
102 | </article>
|
103 | </section>
|
104 |
|
105 |
|
106 |
|
107 |
|
108 |
|
109 |
|
110 | </div>
|
111 |
|
112 | <br class="clear">
|
113 |
|
114 | <footer>
|
115 | 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.
|
116 | </footer>
|
117 |
|
118 | <script>prettyPrint();</script>
|
119 | <script src="scripts/polyfill.js"></script>
|
120 | <script src="scripts/linenumber.js"></script>
|
121 |
|
122 | <script src="scripts/search.js" defer></script>
|
123 |
|
124 |
|
125 |
|
126 | </body>
|
127 | </html>
|