README.md

Twitch.js

A set of libraries that aims to cover all of the existing Twitch APIs.

• Query the Kraken v5 & Helix APIs
• Build a chat bot
• React to custom redemptions, subscriptions, follows and much more using PubSub and WebHooks
• Do all this without caring about the expiry of your access tokens - we can refresh them automatically

Installation

To add Twitch.js to your project, just execute:

yarn add twitch

or using npm:

npm install --save twitch

Documentation

A good place to start with this library is the documentation which also includes a complete reference of all classes and interfaces, as well as changes and deprecations between major versions.

Additional packages

This core package only provides API and authentication functionality. All the other things are located in separate packages:

• twitch-chat-client - connect to and interact with Twitch Chat
• twitch-pubsub-client - listen to events using the Twitch PubSub interface
• twitch-webhooks - listen to events using WebHooks

If you're getting stuck...

You can join the Discord server for support.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Daniel Fischer 💻 📖 💡 🚇 🚧 👀 🔧	Martin Giger 💻 💬	Jakub Kohout 💻	Joe Lafiosca 💻	Dustin Dawes 💻	Jasper Abbink 💻	lclc98 💻
Haley Hitch 💻	Akira 💻	Lewis Gibson 💻	VyrtualSynthese 💻	Nick Ferraro 💻	Jacob Foster 💬 💻	Aaron Kc Hsu 💻
Erik Guzman 💻	Trezy 💻	Travis Tarr 💻	Grégoire Joncour 💻	Maciej Trębacz 💻	Justus Fluegel 💻	Daniel Huber 💻
Adam 💻	Corbin Crutchley 💻	Sam Hirst 💻

This project follows the all-contributors specification. Contributions of any kind welcome!