Cheermote
Represents a Twitch cheermote.
Extends
Base<T>
Type parameters
| Type parameter |
|---|
T extends EventSubConnection |
Constructors
new Cheermote()
1new Cheermote<T>(chatbot: ChatBot<T>, data: Cheermote): Cheermote<T>Creates a new instance of the cheermote.
Parameters
| Parameter | Type | Description |
|---|---|---|
chatbot | ChatBot<T> | The current instance of the chatbot. |
data | Cheermote | The data of the cheermote returned from the API. |
Returns
Cheermote<T>
Overrides
Base<T>.constructor
Source
twitchfy/packages/chatbot/src/structures/Cheermote.ts:43
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
chatbot | readonly | ChatBot<T> | The current instance of the chatbot. | Base.chatbot |
isCharitable | readonly | boolean | Whether the cheermote is charitable. | - |
prefix | readonly | string | The prefix of the cheermote. | - |
tiers | readonly | CheermoteTier<T>[] | The tiers of the cheermote. | - |
type | readonly | CheermoteType | The type of the cheermote. | - |
Accessors
lastUpdated
1get lastUpdated(): DateReturns the last updated date of the cheermote in a JavaScript Date object.
Returns
Date
Source
twitchfy/packages/chatbot/src/structures/Cheermote.ts:55
Methods
getURL()
1getURL(options: CheermoteURLOptions): null | stringGet the URL of the image of cheermote.
Parameters
| Parameter | Type | Description |
|---|---|---|
options | CheermoteURLOptions | The options to get the URL of the cheermote. |
Returns
null | string
The URL of the image of the cheermote.