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 expire, unless a change of level occurs to extend the expiration.
goal
Type: number
The number of points required to reach the next level.
id
Type: string
The ID of the Hype Train.
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()
asyncRetrieves more information about the broadcaster.