@twurple/easy-bot/lib/events/ViewerMilestoneEvent.d.ts

A simplified framework to get a chat bot running easily.

import { type HelixUser } from '@twurple/api';
/**
 * An event representing a viewer milestone in chat.
 *
 * @meta category events
 */
export declare class ViewerMilestoneEvent {
    /**
     * The ID of the broadcaster.
     */
    get broadcasterId(): string;
    /**
     * The name of the broadcaster.
     */
    get broadcasterName(): string;
    /**
     * Gets more information about the broadcaster.
     */
    getBroadcaster(): Promise<HelixUser>;
    /**
     * The ID of the user who reached the milestone.
     */
    get userId(): string;
    /**
     * The name of the user who reached the milestone.
     */
    get userName(): string;
    /**
     * The display name of the user who reached the milestone.
     */
    get userDisplayName(): string;
    /**
     * Gets more information about the user.
     */
    getUser(): Promise<HelixUser>;
    /**
     * The name of the milestone category.
     */
    get categoryName(): string;
    /**
     * The value of the milestone (e.g., number of streams for watch-streak).
     */
    get value(): number | undefined;
    /**
     * The reward received for the milestone (e.g., channel points).
     */
    get reward(): number | undefined;
    /**
     * The message sent with the milestone.
     */
    get message(): string | undefined;
}
//# sourceMappingURL=ViewerMilestoneEvent.d.ts.map