BaseEmote

The base emote class.

Extends

Base<T>

Extended by

Emote

Type parameters

Type parameter	Value
`T` extends `EventSubConnection`	-
`K` extends `EmoteType`	`EmoteType`

Constructors

new BaseEmote()

1
new BaseEmote<T, K>(chatbot: ChatBot<T>, data: BaseEmoteData): BaseEmote<T, K>

Creates a new instance of the base emote.

Parameters

Parameter	Type	Description
`chatbot`	`ChatBot`<`T`>	The current instance of the chatbot.
`data`	`BaseEmoteData`	The base data of the emote.

Returns

BaseEmote<T, K>

Overrides

Base<T>.constructor

Source

twitchfy/packages/chatbot/src/structures/BaseEmote.ts:31

Properties

Property	Modifier	Type	Description	Inherited from
`chatbot`	`readonly`	`ChatBot`<`T`>	The current instance of the chatbot.	`Base.chatbot`
`id`	`readonly`	`string`	The id of the emote.	-
`name`	`readonly`	`string`	The name of the emote.	-

Accessors

animated

1
get animated(): boolean

Whether the emote is animated.

Returns

boolean

Source

twitchfy/packages/chatbot/src/structures/BaseEmote.ts:62

ownerId

1
get ownerId(): null | string

The Id of the owner of the emote.

Returns

null | string

Source

twitchfy/packages/chatbot/src/structures/BaseEmote.ts:41

setId

1
get setId(): null | string

The Id of the emote set.

Returns

null | string

Source

twitchfy/packages/chatbot/src/structures/BaseEmote.ts:48

static

1
get static(): boolean

Whether the emote is static.

Returns

boolean

Source

twitchfy/packages/chatbot/src/structures/BaseEmote.ts:55

Methods

fetch()

1
fetch(): Promise<null | FetchEmote<T, K>>

Fetches the emote from the API.

Returns

Promise<null | FetchEmote<T, K>>

The fetched emote. Returns null if the emote was not found.

Source

twitchfy/packages/chatbot/src/structures/BaseEmote.ts:86

isChannel()

1
isChannel(): this is BaseEmote<T, "channel">

Check if the emote is a custom channel emote.

Returns

this is BaseEmote<T, "channel">

A boolean indicating whether the emote is a channel emote.

Source

twitchfy/packages/chatbot/src/structures/BaseEmote.ts:78

isGlobal()

1
isGlobal(): this is BaseEmote<T, "global">

Check if the emote is a global Twitch emote.

Returns

this is BaseEmote<T, "global">

A boolean indicating whether the emote is a global Twitch emote.

Source

twitchfy/packages/chatbot/src/structures/BaseEmote.ts:70