twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

Basic usage

Getting startedConnecting to ChatListening to events

Upgrading

Upgrading to 2.xUpgrading to 3.xUpgrading to 4.x

Examples

Basic botPreventing sub gift spam

Classes

ChatClientChatUserTwitchPrivateMessageUserNotice

Interfaces

BaseChatClientOptionsChatBitsBadgeUpgradeInfoChatCommunityPayForwardInfoChatCommunitySubInfoChatPrimeCommunityGiftInfoChatRaidInfoChatRewardGiftInfoChatRitualInfoChatSayMessageAttributesChatStandardPayForwardInfoChatSubExtendInfoChatSubGiftInfoChatSubGiftUpgradeInfoChatSubInfoChatSubUpgradeInfoParsedMessageCheerPartParsedMessageEmotePartParsedMessageTextPartTcpChatClientOptionsWebSocketChatClientOptions

ChatSubUpgradeInfo

Information about a subscription that was upgraded from a Prime subscription.

{
The display name of the subscribing user.
displayName: string
The plan ID of the subscription.
plan: string
The user ID of the subscribing user.
userId: string
}

Properties

displayName

Type: string

The display name of the subscribing user.

plan

Type: string

The plan ID of the subscription.

Tier 1, 2, 3 are '1000', '2000', '3000' respectively, and a Twitch Prime subscription is called 'Prime'.

userId

Type: string

The user ID of the subscribing user.