CheermoteTier
Represents a Twitch cheermote tier.
Extends
Base
<T
>
Type parameters
Type parameter |
---|
T extends EventSubConnection |
Constructors
new CheermoteTier()
1new CheermoteTier<T>(2 chatbot: ChatBot<T>,3 cheermote: Cheermote<T>,4data: CheermoteTier): CheermoteTier<T>
Creates a new instance of the cheermote tier.
Parameters
Parameter | Type | Description |
---|---|---|
chatbot | ChatBot <T > | The current instance of the chatbot. |
cheermote | Cheermote <T > | The cheermote of the tier. |
data | CheermoteTier | The data of the cheermote tier returned from the API. |
Returns
Overrides
Base<T>.constructor
Source
twitchfy/packages/chatbot/src/structures/CheermoteTier.ts:49
Properties
Property | Modifier | Type | Description | Inherited from |
---|---|---|---|---|
canCheer | readonly | boolean | Whether the user can cheer with this tier. | - |
chatbot | readonly | ChatBot <T > | The current instance of the chatbot. | Base.chatbot |
cheermote | readonly | Cheermote <T > | The cheermote of the tier. | - |
color | readonly | string | The color of the tier. | - |
minBits | readonly | number | The minimum bits necessary to cheer with this tier. | - |
showInBitsCard | readonly | boolean | Whether the tier should be shown in the bits card. | - |
Accessors
id
1get id(): number
The Id of the cheermote tier.
Returns
number
Source
twitchfy/packages/chatbot/src/structures/CheermoteTier.ts:62
Methods
getURL()
1getURL(options?: Omit<CheermoteURLOptions, "tier">): string
Get the URL of the image of the cheermote tier.
Parameters
Parameter | Type | Description |
---|---|---|
options ? | Omit <CheermoteURLOptions , "tier" > | The options to get the URL of the cheermote tier. |
Returns
string
The URL of the image of the cheermote tier.
Source
twitchfy/packages/chatbot/src/structures/CheermoteTier.ts:72