@axel669/twitch

Axel669's Twitch Lib

Simple library for doing things with twitch chat and pubsub thats made for the browser.

Installation

yarn/npm

npm add @axel669/twitch

Browser

<script src="https://cdn.jsdelivr.net/npm/@axel669/twitch/browser/twitch.js"></script>

Usage

Client Side Bundled

import {Chat, EventSub, Multi} from "@axel669/twitch/browser"

Require

No longer supported directly.

Import

import {Chat, EventSub, Multi} from "@axel669/twitch"
//  also has a named /node export available if projects also use the browser
//  import this can help avoid some confusion
import {Chat, EventSub, Multi} from "@axel669/twitch/node"

Browser

If the cdn script tag is used

twitch.Chat(...)
twitch.EventSub(...)
twitch.Multi(...)

Events

Library uses EventBridge to manage events, see there for more details about how listeners work. All of the objects created pass the on functions from the internal bridge it uses.

Chat API

import {Chat} from "@axel669/twitch"

const chat = Chat({
    user: {
        name: "<username>",
        token: "<oauth token>",
    },
    channel: "<channel>"
})

chat.on(
    "chat.*",
    ({ data }) => console.log(data.tags.displayName, data.message)
)
chat.on(
    "bits",
    ({ data }) => console.log(data.tags.displayName, "gave", data.tags.bits)
)
chat.on(
    "sub.*",
    ({ data }) => console.log("sub", data)
)
await chat.connect()
await chat.say("message")
await chat.say("reply thread", "<msg id replied to>")
chat.disconnect()

Chat Event List

This is a list of the events that are currently parsed and sorted through. There are still some irc commands it doesn't parse (I didn't really see a reason to, but I'm also lazy), and those can be captured with the * event. Those events will always be full caps like the commands.

• system - System messages that come through the socket (I got pretty lazy about parsing these)
• ping - Twitch sends a ping every few minutes, the library automatically sends back the poing message expected to keep the connection alive, but you can use this event to do something custom as well
• chat.redeem - any custom redeem that has text attached to it
• chat.message - any chat message that comes through that isn't a sub-based event (including redeems that have a chat message attached) NOTE: highlighted message redeems come through here with the tag msgID set to "highlighted-message"
• join/part - Sent when users are marked as joining or leaving a chat. These are not guaranteed to happen immediately but could be used to keep track of an approximate user list.
• raid/unraid - Start or cancelled raids
• sub.new - New subscription to the channel
• sub.resub - Resubs
• sub.gift - When someone is given a gift sub from a user
• sub.gift.anon - Gift sub from anon user
• sub.gift.mystery - This event is fired when someone gifts to the community. The individual recipients will each get a sub.gift or sub.gift.anon.
• sub.upgrade - User continues a gifted sub
• sub.upgrade.anon - User continues a gift sub from an anon user

Pubsub API (deprecated)

This API is deprecated in favor of the EventSub API.

const pubsub = twitch.Pubsub({
    user: {
        id: "<user id>",
        token: "<oauth token>"
    },
    topics: [
        "channel-points-channel-v1"
    ]
})
pubsub.on(
    "channel-points-channel-v1",
    ({ data }) => console.log(data.redemption.reward.title)
)
await pubsub.connect()
//  some time later
pubsub.disconnect()

EventSub API

const eventsub = twitch.EventSub({
    user: {
        id: "<user id>",
        token: "<oauth token>"
    },
    clientID: "lskadjfklsaf",
    topics: [
        "channel.follow"
    ]
})
eventsub.on(
    "channel.follow",
    ({ data }) => console.log(`${data.user_name} followed!`)
)
await eventsub.connect()
//  some time later
eventsub.disconnect()

EventSub Subscriptions

EventSub connects to Twitch's beta EventSub Websocket. Topics are the exact subscription topic that Twitch has listed for an event, and the events fired will use the same name as the subscription topic. Subscription Topics

Event List

The Pubsub will fire events based on the topics passed into the object on creation. it will fire an event with the type of the topic without any of the IDs attached. A full list of the pubsub topics and message data can be found Here.

Multi API

The Multi function takes the user, token, and topics properties from the Chat and EventSub functions and instantiates both of them internally. It fires events from both of them, and its connect and disconnect functions trigger for both internal objects. It also passes the say function from the Chat object.

Might add other connectors in the future.

const multi = twitch.Multi({
    connectors: [twitch.Chat, twitch.EventSub],
    user {
        name: "<username>",
        id: "<user id>",
        token: "<oauth token>"
    },
    channel: "<channel>",
    topics: [
        "channel.follow"
    ]
})

multi.on("chat.message", console.log)
multi.on("channel.follow", console.log)

//  returns an array of connectors .connect() results
await multi.connect()
await multi.say("message")
await multi.say("reply thread", "<msg id replied to>")
multi.disconnect()