tmi.js

Documentation

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

Install

Node

$ npm i tmi.js --save

Browser

Available as "tmi" on window.

<script src="/scripts/tmi.min.js"></script>

Prebuilt Releases

Release page

Build Yourself

$ git clone https://github.com/tmijs/tmi.js.git
$ npm install
$ npm start build

Content Delivery Network (CDN)

Not available at the moment.

Community

• Follow @Schmoopiie on Twitter.
• Follow @AlcaMagic on Twitter.

• Found a bug: submit an issue.
• Discussion and help about tmi.js: Twitch API Discord Server
• For everything else: Official TwitchDev Discord Server

Contributors

In order of the most commits:

• Schmoopiie - https://github.com/Schmoopiie
• AlcaDesign - https://github.com/AlcaDesign
• ben-eb - https://github.com/ben-eb
• d-fischer - https://github.com/d-fischer
• celluj34 - https://github.com/celluj34
• dbkynd - https://github.com/dbkynd
• JDBar - https://github.com/JDBar
• subperks - https://github.com/subperks
• roberthartung - https://github.com/roberthartung
• JohnnyToumieh - https://github.com/JohnnyToumieh
• mdolr - https://github.com/mdolr
• sfsepark - https://github.com/sfsepark
• Jonliney - https://github.com/Jonliney
• UnwrittenFun - https://github.com/UnwrittenFun
• justinsacbibit - https://github.com/justinsacbibit
• lauriys - https://github.com/lauriys
• mccxiv - https://github.com/mccxiv
• derpierre65 - https://github.com/derpierre65
• SnareChops - https://github.com/SnareChops
• haganbmj - https://github.com/haganbmj
• artemisbot - https://github.com/artemisbot
• joein3d - https://github.com/joein3d
• mertzt89 - https://github.com/mertzt89
• smalls89 - https://github.com/smalls89
• Egonny - https://github.com/egonny
• Hatsuney - https://github.com/Hatsuney
• ImNatho - https://github.com/ImNatho

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.