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

Core functionality

BotBotCommandBotCommandContext

Events

AnnouncementEventBanEventBitsBadgeUpgradeEventChatClearEventCommunityPayForwardEventCommunitySubEventEmoteOnlyToggleEventFollowersOnlyToggleEventGiftPaidUpgradeEventJoinEventJoinFailureEventLeaveEventMessageEventMessageRemoveEventPrimePaidUpgradeEventRaidCancelEventRaidEventSlowModeToggleEventStandardPayForwardEventSubEventSubGiftEventSubsOnlyToggleEventUniqueChatToggleEventWhisperEvent

Functions

createBotCommand

Interfaces

BotConfigCreateBotCommandOptions

Type aliases

BotAuthMethodChatAnnouncementColor

JoinEvent

An event representing a user joining a channel.

Overview

Properties

Methods

The join/leave events are cached by the Twitch chat server and will be batched and sent every 30-60 seconds.

Please note that if you have not enabled the requestMembershipEvents option or the channel has more than 1000 connected chatters, this will only react to your own joins.

Properties

broadcasterName

Type: string

The name of the broadcaster.

userName

Type: string

The name of the user.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getUser()

async

Gets more information about the user.

Return type: HelixUser

leave()

Leaves the channel.

Return type: void