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

Basic usage

Getting startedListening to events

Special hosting

Serving through a reverse proxyTesting locally using ngrok

Classes

ConnectionAdapterDirectConnectionAdapterEnvPortAdapterEventSubChannelBanEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelSubscriptionEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubListenerEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationRevokeEventEventSubUserUpdateEventMiddlewareAdapterReverseProxyAdapter

Interfaces

ConnectCompatibleAppDirectConnectionAdapterConfigEnvPortAdapterConfigEventSubConfigEventSubListenerCertificateConfigMiddlewareAdapterConfigReverseProxyAdapterConfig

EventSubChannelHypeTrainBeginEvent

An EventSub event representing a Hype Train starting in a channel.

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

expiryDate

Type: Date

The time when the Hype Train is expected to expire, unless a change of level occurs to extend the expiration.

goal

Type: number

The number of points required to reach the next level.

lastContribution

Type: EventSubChannelHypeTrainContribution

The last contribution to the Hype Train.

progress

Type: number

The number of points contributed to the Hype Train at the current level.

startDate

Type: Date

The time when the Hype Train started.

topContributors

Type: Array<EventSubChannelHypeTrainContribution>

The top contributors for the Hype Train in terms of bits and subscriptions.

total

Type: number

The total points already contributed to the Hype Train.

Methods

getBroadcaster()

async

Retrieves more information about the broadcaster.

Return type: HelixUser