| 1 | <!DOCTYPE html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 |
|
| 5 | <meta charset="utf-8">
|
| 6 | <title>Home - 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 |
|
| 44 |
|
| 45 |
|
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 | <section class="package">
|
| 52 | <h3> </h3>
|
| 53 | </section>
|
| 54 |
|
| 55 |
|
| 56 |
|
| 57 |
|
| 58 |
|
| 59 |
|
| 60 |
|
| 61 |
|
| 62 |
|
| 63 |
|
| 64 |
|
| 65 |
|
| 66 |
|
| 67 | <section class="readme usertext">
|
| 68 | <article><h1><strong>:triangular_flag_on_post: TWIT-STREAM</strong> (version 1.0.0)</h1>
|
| 69 | <blockquote>
|
| 70 | <p>Streaming from v2 twitter API</p>
|
| 71 | </blockquote>
|
| 72 | <hr>
|
| 73 | <h2><strong>Documentation</strong></h2>
|
| 74 | <ul>
|
| 75 | <li><a href="https://crunchwrapsupreme.github.io/twit-stream-v2/index.html">API Documentation</a></li>
|
| 76 | </ul>
|
| 77 | <hr>
|
| 78 | <h2><strong>:package: Main tools used</strong></h2>
|
| 79 | <ul>
|
| 80 | <li>[x] axios</li>
|
| 81 | </ul>
|
| 82 | <hr>
|
| 83 | <h2><strong>:wrench: Developer usage</strong></h2>
|
| 84 | <ul>
|
| 85 | <li>[x] eslint</li>
|
| 86 | <li>[x] mocha</li>
|
| 87 | <li>[x] jsdoc</li>
|
| 88 | <li>[x] docdash</li>
|
| 89 | </ul>
|
| 90 | <h3><strong>Set up project</strong></h3>
|
| 91 | <ul>
|
| 92 | <li>Choose a folder project in your system and switch in <code>cd [folder path]</code></li>
|
| 93 | <li>Clone the repo in your folder path</li>
|
| 94 | </ul>
|
| 95 | <hr>
|
| 96 | <h3><strong>Installation</strong></h3>
|
| 97 | <p>In order to install the project and all dependencies, enter in the project folder and run <code>npm install</code></p>
|
| 98 | <hr>
|
| 99 | <h3>Test the project</h3>
|
| 100 | <pre class="prettyprint source lang-bash"><code>npm test
|
| 101 | </code></pre>
|
| 102 | <hr>
|
| 103 | <h2><strong>:handshake: Contributing</strong></h2>
|
| 104 | <ul>
|
| 105 | <li>Fork it!</li>
|
| 106 | <li>Create your feature branch: <code>git checkout -b my-new-feature</code></li>
|
| 107 | <li>Commit your changes: <code>git commit -am 'Add some feature'</code></li>
|
| 108 | <li>Push to the branch: <code>git push origin my-new-feature</code></li>
|
| 109 | <li>Submit a pull request</li>
|
| 110 | </ul>
|
| 111 | <hr>
|
| 112 | <h3><strong>:heart: Show your support</strong></h3>
|
| 113 | <p>Please :star: this repository if you like it or this project helped you!<br>
|
| 114 | Feel free to open issues or submit pull-requests to help me improving my work.</p>
|
| 115 | <hr>
|
| 116 | <h3><strong>:robot: Author</strong></h3>
|
| 117 | <p><em><em>David Young</em></em></p>
|
| 118 | <hr>
|
| 119 | <p>Copyright © 2020 David Young</p></article>
|
| 120 | </section>
|
| 121 |
|
| 122 |
|
| 123 |
|
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 |
|
| 129 | </div>
|
| 130 |
|
| 131 | <br class="clear">
|
| 132 |
|
| 133 | <footer>
|
| 134 | 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.
|
| 135 | </footer>
|
| 136 |
|
| 137 | <script>prettyPrint();</script>
|
| 138 | <script src="scripts/polyfill.js"></script>
|
| 139 | <script src="scripts/linenumber.js"></script>
|
| 140 |
|
| 141 | <script src="scripts/search.js" defer></script>
|
| 142 |
|
| 143 |
|
| 144 |
|
| 145 | </body>
|
| 146 | </html> |
| \ | No newline at end of file |