@twitchfy/chatbot/dist/structures/CheermoteTier.d.ts

A powerful node module to make your own Twitch ChatBot

import type { CheermoteTier as CheermoteTierData } from '@twitchfy/api-types';
import { Base } from './Base';
import type { ChatBot } from './ChatBot';
import type { Cheermote } from './Cheermote';
import type { EventSubConnection } from '../enums';
import type { CheermoteURLOptions } from '../interfaces';
/**
 * Represents a Twitch cheermote tier.
 */
export declare class CheermoteTier<T extends EventSubConnection> extends Base<T> {
    /**
     * The cheermote of the tier.
     */
    readonly cheermote: Cheermote<T>;
    /**
     * Whether the user can cheer with this tier.
     */
    readonly canCheer: boolean;
    /**
     * The color of the tier.
     */
    readonly color: string;
    /**
     * The minimum bits necessary to cheer with this tier.
     */
    readonly minBits: number;
    /**
     * Whether the tier should be shown in the bits card.
     */
    readonly showInBitsCard: boolean;
    /**
     * The data of the cheermote tier returned from the API.
     */
    private data;
    /**
     * Creates a new instance of the cheermote tier.
     * @param chatbot The current instance of the chatbot.
     * @param cheermote The cheermote of the tier.
     * @param data The data of the cheermote tier returned from the API.
     */
    constructor(chatbot: ChatBot<T>, cheermote: Cheermote<T>, data: CheermoteTierData);
    /**
     * The Id of the cheermote tier.
     */
    get id(): number;
    /**
     * Get the URL of the image of the cheermote tier.
     * @param options The options to get the URL of the cheermote tier.
     * @returns The URL of the image of the cheermote tier.
     */
    getURL(options?: Omit<CheermoteURLOptions, 'tier'>): string;
}