@twitchfy/chatbot
Version:
A powerful node module to make your own Twitch ChatBot
31 lines (30 loc) • 1.02 kB
TypeScript
import type { ChannelEmote as ChannelEmoteData, EmoteType } from '@twitchfy/api-types';
import type { ChatBot } from './ChatBot';
import { Emote } from './Emote';
import type { EventSubConnection } from '../enums';
/**
* Represents a Twitch channel emote.
*/
export declare class ChannelEmote<T extends EventSubConnection> extends Emote<T, 'channel'> {
/**
* The type of the emote.
*/
readonly type: EmoteType;
/**
* The Id of the emote set.
*/
readonly emoteSetId: string;
constructor(chatbot: ChatBot<T>, data: ChannelEmoteData & {
template: string;
owner_id: string;
});
/**
* Overrides isChannel method from BaseEmote to assert this as ChannelEmote and not BaseEmote.
* @returns Whether the emote is a channel emote.
*/
isChannel(): this is ChannelEmote<T>;
/**
* Returns the subscription tier necessary to use the emote. If the emote is not a subscription emote, it will return null.
*/
get tier(): number | null;
}