Skip to content

README.md

Latest commit

 

History

History
57 lines (39 loc) · 1.47 KB

README.md

File metadata and controls

57 lines (39 loc) · 1.47 KB

TwitchLive

A Node.JS library to connect to Twitch stream chats and grab some of that sweet, freely available data.

TwitchLive is a Node.JS library designed to connect to Twitch livestreams and receive realtime chat events. This is particularly useful for use cases where Twitch's official API is too permissions-restrictive

Warning:
This is a reverse-engineering project. Unless you are capable of maintaining it, do not use this in production systems. I do fix issues as they arise, but on my own time.

Join the community discord (yes, TikTokLive Discord) and visit the #twitch-support channel for questions, contributions and ideas.

Table of Contents

Getting Started

  1. Install the module via npm from the Coming Soon repository
npm i twitchlive
  1. Create your first chat connection
import {TwitchLiveClient, LiveEvent} from "twitchlive";

const client = new TwitchLiveClient(
    "cheese.whiz"
);

client.on(LiveEvent.CONNECTED, (e: undefined) => {
  console.log('Connected!')
});

Current Events

export enum LiveEvent {
  CONNECTED = "connected",
  DISCONNECTED = "disconnected",
  ERROR = "error",
  FETCH_COMMENTS = "fetch_comments",
  COMMENT = "comment",
  EMOJI = "emoji"
}

License

This project is licensed under the MIT License - see the LICENSE file for details.