@twurple/eventsub-base
Version:
Base for the other Twurple EventSub packages
66 lines • 2.06 kB
TypeScript
import type { HelixUser } from '@twurple/api';
import { DataObject } from '@twurple/common';
import { EventSubChannelHypeTrainContribution } from './common/EventSubChannelHypeTrainContribution';
import { type EventSubChannelHypeTrainProgressEventData } from './EventSubChannelHypeTrainProgressEvent.external';
/**
* An EventSub event representing progress towards the Hype Train goal.
*/
export declare class EventSubChannelHypeTrainProgressEvent extends DataObject<EventSubChannelHypeTrainProgressEventData> {
/**
* The ID of the Hype Train.
*/
get id(): string;
/**
* The ID of the broadcaster.
*/
get broadcasterId(): string;
/**
* The name of the broadcaster.
*/
get broadcasterName(): string;
/**
* The display name of the broadcaster.
*/
get broadcasterDisplayName(): string;
/**
* Gets more information about the broadcaster.
*/
getBroadcaster(): Promise<HelixUser>;
/**
* The current level of the Hype Train.
*/
get level(): number;
/**
* The total points contributed to the Hype Train.
*/
get total(): number;
/**
* The number of points contributed to the Hype Train at the current level.
*/
get progress(): number;
/**
* The number of points required to reach the next level.
*/
get goal(): number;
/**
* The contributors with the most points, for both bits and subscriptions.
*/
get topContributors(): EventSubChannelHypeTrainContribution[];
/**
* The most recent contribution.
*/
get lastContribution(): EventSubChannelHypeTrainContribution;
/**
* The time when the Hype Train started.
*/
get startDate(): Date;
/**
* The time when the Hype Train is expected to end, unless extended by reaching the goal.
*/
get expiryDate(): Date;
/**
* Indicates if the Hype Train is a Golden Kappa Train.
*/
get isGoldenKappaTrain(): boolean;
}
//# sourceMappingURL=EventSubChannelHypeTrainProgressEvent.d.ts.map