@twurple/common
Version:
Common functions used by the `@twurple` library family.
51 lines • 1.32 kB
TypeScript
import { DataObject } from '../DataObject';
import { type ChatEmoteData } from './ChatEmote.external';
/**
* The possible animation settings for an emote image.
*/
export declare type EmoteAnimationSettings = 'default' | 'static' | 'animated';
/**
* The possible background types to optimize the emote display for.
*/
export declare type EmoteBackgroundType = 'light' | 'dark';
/**
* The possible emote size multipliers.
*/
export declare type EmoteSize = '1.0' | '2.0' | '3.0';
/**
* The display settings for an emote.
*/
export interface EmoteSettings {
/**
* The animation settings of the emote.
*/
animationSettings: EmoteAnimationSettings;
/**
* The background type of the emote.
*/
backgroundType: EmoteBackgroundType;
/**
* The size multiplier of the emote.
*/
size: EmoteSize;
}
/**
* A chat emote.
*/
export declare class ChatEmote extends DataObject<ChatEmoteData> {
/**
* The emote ID.
*/
get id(): string;
/**
* The emote code, i.e. how you write it in chat.
*/
get code(): string;
/**
* Build the URL pointing to the emote image.
*
* @param settings The display settings of the emote image.
*/
getUrl(settings: EmoteSettings): string;
}
//# sourceMappingURL=ChatEmote.d.ts.map