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

ChatCommunitySubInfo

Information about a community gift subscription.

{
The number of subscriptions that were gifted to the channel.
count: number
The name of the user that gifted the subscription(s).
gifter?: string
The display name of the user that gifted the subscription(s).
The number of subscriptions the gifting user has already gifted in total.
The user ID of the user that gifted the subscription(s).
gifterUserId?: string
The plan ID of the subscription(s).
plan: string
}

Properties

count

Type: number

The number of subscriptions that were gifted to the channel.

gifter

Type: ?string

The name of the user that gifted the subscription(s).

gifterDisplayName

Type: ?string

The display name of the user that gifted the subscription(s).

gifterGiftCount

Type: ?number

The number of subscriptions the gifting user has already gifted in total.

gifterUserId

Type: ?string

The user ID of the user that gifted the subscription(s).

plan

Type: string

The plan ID of the subscription(s).

Tier 1, 2, 3 are '1000', '2000', '3000' respectively. Prime subscriptions can't be gifted.