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

ChatRewardGiftInfo

Information about a Reward Gift triggered by a special event.

{
The amount of rewards that were shared.
count: number
The domain of the reward, i.e. an identifier of the special event that caused these rewards.
domain: string
The display name of the gifter.
The amount of total rewards the user shared.
gifterGiftCount: number
The user ID of the gifter.
gifterId: string
The type of trigger that caused these rewards.
triggerType: string
}

Properties

count

Type: number

The amount of rewards that were shared.

domain

Type: string

The domain of the reward, i.e. an identifier of the special event that caused these rewards.

gifterDisplayName

Type: string

The display name of the gifter.

gifterGiftCount

Type: number

The amount of total rewards the user shared.

gifterId

Type: string

The user ID of the gifter.

triggerType

Type: string

The type of trigger that caused these rewards.

The only known value of this is "CHEER".