twitch-tmi.js

tmi.js - Twilight Edition

This is an internal fork of the OSS project tmi.js - the client library twilight uses to communicate with the twitch chat backend services. The original repo has a documentation page, but it may not be up to date.

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

Release process for the Twilight fork (this repo)

• Test changes to your local branch using npm link before making a PR.
• Once your PR is merged to master, pull the latest down to your local machine and run npm build.
• Double check that you are authenticated with the private NPM registry: npm login --registry http://npm-registry-prod-def.internal.justin.tv User name and password are both npm_user. Use your justin.tv email when prompted (read here for troubleshooting).
• Bump the package version and publish to our internal npm registry using npm version with one of the following arguments, depending on how significant your changes are:
  • patch (0.0.x) versions introduce additive or subtractive features that will not break previous implementations.
  • minor (0.x.0) versions introduce breaking or potentially breaking changes.
  • major (x.0.0) versions are for symbolic, milestone, or major infrastructural releases, and should also be considered potentially breaking.
• Tag the release using GHE's releases page with a description of the changes made.
• Create a new branch from latest twilight master, and run yarn upgrade twitch-tmi.js. Confirm the changes to package.json and yarn.lock correspond to the version to just published.
• Make a PR to twilight with the version bump changes, as well as any corresponding changes to twilight's usage of tmi.js.
• 🏁

Twilight Maintainers

For questions that pertain specifically to how the twilight fork differs from the OSS version, or about the release process for this repo, ping @ahmad, @noahm, or @mikecheb on slack. Failing that, reach out to the browser clients team in #twilight.

TMI OSS Community

The rest of this info pertains to the OSS library only.

• 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
• 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
• justinsacbibit - https://github.com/justinsacbibit
• Hatsuney - https://github.com/Hatsuney
• ImNatho - https://github.com/ImNatho
• Jonliney - https://github.com/Jonliney
• UnwrittenFun - https://github.com/UnwrittenFun
• joein3d - https://github.com/joein3d
• egonny - https://github.com/egonny
• smalls89 - https://github.com/smalls89
• mertzt89 - https://github.com/mertzt89
• artemisbot - https://github.com/artemisbot