@mkody/twitch-emoticons/src/struct/TwitchEmote.js

Gets Twitch, BTTV, FFZ and 7TV emotes as well as parsing text to emotes!

const Emote = require('./Emote');
const Constants = require('../util/Constants');

/** @augments Emote */
class TwitchEmote extends Emote {
    /**
     * A Twitch emote.
     * @param {Channel} channel - Channel this emote belongs to.
     * @param {string} id - ID of the emote.
     * @param {data} data - The raw emote data.
     */
    constructor(channel, id, data) {
        super(channel, id, data);
        this.type = 'twitch';
    }

    /**
     * The channel of this emote's creator.
     * @readonly
     * @type {Channel}
     */
    get owner() {
        return this.channel;
    }

    _setup(data) {
        super._setup(data);

        /**
         * The set ID of the emote.
         * @type {?string}
         */
        this.set = data.emoticon_set;

        /**
         * If emote is animated.
         * @type {boolean}
         */
        this.animated = 'animated' in data.formats;

        /**
         * The image type of the emote.
         * @type {string}
         */
        this.imageType = 'animated' in data.formats ? 'gif' : 'png';
    }

    /**
     * Gets the image link of the emote.
     * @param {number} size - The size of the image, 0, 1, or 2.
     * @returns {string}
     */
    toLink(size = 0) {
        return Constants.Twitch.CDN(this.id, size); // eslint-disable-line new-cap
    }

    /**
     * Override for `toObject`.
     * Will result in an Object representation of a TwitchEmote
     * @returns {object}
     */
    toObject() {
        return Object.assign({}, super.toObject(), {
            animated: this.animated,
            set: this.set,
            type: this.type
        });
    }

    /**
     * Converts an emote Object into a TwitchEmote
     * @param {object} [emoteObject] - Object representation of this emote
     * @param {Channel} [channel=null] - Channel this emote belongs to.
     * @returns {TwitchEmote}
     */
    static fromObject(emoteObject, channel = null) {
        return new TwitchEmote(channel, emoteObject.id,
            {
                code: emoteObject.code,
                animated: emoteObject.animated,
                emoticon_set: emoteObject.set,
                formats: emoteObject.animated ? { animated: emoteObject.animated } : {}
            });
    }
}

module.exports = TwitchEmote;