tmi.js

tmi.js

The best place to start with tmi.js is our documentation page.

This module currently support Node.js 4.x and every browser that support WebSockets. The current WebSocket protocol being used by this module is HyBi drafts 13-17.

Install

Node

Install Node using this tutorial. Once installed, jump to the documentation to get started.

npm i tmi.js --save

CDN provided by MaxCDN

Reference the file directly in the script tag.

We support Subresource Integrity (SRI) which allows the browser to verify that the files being delivered have not been modified. This https://www.w3.org/TR/SRI/ is currently being implemented by browsers. Adding the new integrity attribute will ensure your application gains this security improvement as browsers support it.

Use Subresource Integrity only if you reference a specific version of tmi.js.

<!--Sourcemap: //cdn.tmijs.org/js/1.1.0/tmi.js.map-->
<script src="//cdn.tmijs.org/js/1.1.1/tmi.min.js" integrity="sha384-8Q+qSu52Px9pRIc72XaZ9pFAFWO/bidhybR512f3TwwFKkdwyvF/lVKixrhp4u3h" crossorigin="anonymous"></script>

You must provide the major version when using the latest branch.

<!--Sourcemap: //cdn.tmijs.org/js/latest/1.x/tmi.js.map-->
<script src="//cdn.tmijs.org/js/latest/1.x/tmi.min.js"></script>

Community

• Follow @Schmoopiie on Twitter.
• Have a question that is not a bug report ? Discuss on the tmi.js forum.
• Found a bug ? Submit an issue.

Contributors

In order of the most commits:

• Schmoopiie - https://github.com/Schmoopiie
• ben-eb - https://github.com/ben-eb
• AlcaDesign - https://github.com/AlcaDesign
• celluj34 - https://github.com/celluj34
• d-4-ni - https://github.com/d-4-ni
• UnwrittenFun - https://github.com/UnwrittenFun
• Hatsuney - https://github.com/Hatsuney
• justinsacbibit - https://github.com/justinsacbibit
• joein3d - https://github.com/joein3d
• egonny - https://github.com/egonny
• smalls89 - https://github.com/smalls89
• subperks - https://github.com/subperks
• mertzt89 - https://github.com/mertzt89

Contributing guidelines

Please review the guidelines for contributing of the tmi.js repository. We reserve the right to refuse a Pull Request if it does not meet the requirements.