TwitchEmote

TwitchEmote

new TwitchEmote(channel, id, data)

Description:

  • A Twitch emote.

Source:
Parameters:
Name Type Description
channel Channel

Channel this emote belongs to.
id string

ID of the emote.
data data

The raw emote data.

Extends

Members

(nullable) set :string

Description:

  • The set ID of the emote.

Source:

The set ID of the emote.

Type:
  • string

animated :boolean

Description:

  • If emote is animated.

Source:

If emote is animated.

Type:
  • boolean

imageType :string

Description:

  • The image type of the emote.

Source:

The image type of the emote.

Type:
  • string

fetcher :EmoteFetcher

Description:

  • The emote fetcher.

Source:
Overrides:

The emote fetcher.

Type:

channel :Channel

Description:

  • The channel this emote belongs to. Only accurate and constant on Twitch emotes. For other types of emotes, use the owner or ownerName property.

Source:
Overrides:

The channel this emote belongs to. Only accurate and constant on Twitch emotes. For other types of emotes, use the owner or ownerName property.

Type:

id :string

Description:

  • The ID of this emote.

Source:
Overrides:

The ID of this emote.

Type:
  • string

type :string|null

Description:

  • The type of this emote. Either twitch, bttv, ffz, or '7tv'.

Source:
Overrides:

The type of this emote. Either twitch, bttv, ffz, or '7tv'.

Type:
  • string | null

code :string

Description:

  • The code or name of the emote.

Source:
Overrides:

The code or name of the emote.

Type:
  • string

Methods

Description:

  • Gets the image link of the emote.

Source:
Parameters:
Name Type Attributes Description
options object <optional>

Options for the link.

Properties
Name Type Attributes Default Description
size number <optional>
 0

Size (scale) for the emote.
forceStatic boolean <optional>

Whether to force the emote to be static (non-animated). Defaults to the fetcher's forceStatic or false.
themeMode 'dark' | 'light' <optional>

Only for Twitch: the preferred theme mode. Defaults to the fetcher's twitchThemeMode or dark.
Returns:
  • The URL to the emote.
Type
string

toObject() → {object}

Description:

  • Override for toObject. Will result in an Object representation of a TwitchEmote

Source:
Overrides:
Returns:
  • Object representation of the TwitchEmote.
Type
object

(static) fromObject(emoteObjectopt, channelopt) → {TwitchEmote}

Description:

  • Converts an emote Object into a TwitchEmote

Source:
Parameters:
Name Type Attributes Description
emoteObject object <optional>

Object representation of this emote
channel Channel <optional>

Channel this emote belongs to.
Returns:
  • A TwitchEmote instance.
Type
TwitchEmote