Overview
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 end, unless
extended by reaching the goal.
goal
Type:
number
The number of points required to reach the next level.
lastContribution
Type:
EventSubChannelHypeTrainContribution
The most recent contribution.
level
Type:
number
The current level of 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.
topContributions
Type:
Array<EventSubChannelHypeTrainContribution>
The contributors with the most points, for both bits and
subscriptions.
total
Type:
number
The total points contributed to the Hype Train.
Methods
getBroadcaster()
async
Retrieves more information about the broadcaster.