TwurpleAuthenticationGetting dataExamplesFAQMigration
Reference
apiapi-callauthauth-tmichatcommoneasy-botebs-helpereventsub-baseeventsub-httpeventsub-wspubsub

Core functionality

BotBotCommandBotCommandContext

Events

AnnouncementEventBanEventBitsBadgeUpgradeEventChatClearEventCommunityPayForwardEventCommunitySubEventEmoteOnlyToggleEventFollowersOnlyToggleEventGiftPaidUpgradeEventJoinEventJoinFailureEventLeaveEventMessageEventMessageRemoveEventPrimePaidUpgradeEventRaidCancelEventRaidEventSlowModeToggleEventStandardPayForwardEventSubEventSubGiftEventSubsOnlyToggleEventUniqueChatToggleEventWhisperEvent

Functions

createBotCommand

Interfaces

BotConfigCreateBotCommandOptions

Type aliases

BotAuthMethodChatAnnouncementColor

SubGiftEvent

An event representing a user gifting a subscription to another user.

Overview

Properties

Methods

Properties

gifterDisplayName

Type: string | null

The display name of the user who sent the gift.

gifterId

Type: string | null

The ID of the user who sent the gift.

gifterName

Type: string | null

The name of the user who sent the gift.

Methods

getGifter()

async

Gets more information about the user who sent the gift.

Return type: HelixUser | null