HelixCheermoteList
A list of cheermotes you can use globally or in a specific channel, depending on how you fetched the list.
Overview
Methods
getCheermoteDisplayInfo(name, bits, format)
Gets the URL and color needed to properly represent a cheer of the given amount of bits with the given prefix.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| name | string | none | The name/prefix of the cheermote. | |
| bits | number | none | The amount of bits cheered. | |
| format | Partial<CheermoteFormat> | {} | The format of the cheermote you want to request. |
Return type: CheermoteDisplayInfo
parseMessage(message)
Parses all the cheermotes out of a message.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| message | string | none | The message. |
Return type: Array<MessageCheermote>
transformCheerMessage<T>(message, transformer)
Transforms all the cheermotes in a message and returns an array of all the message parts.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| message | string | none | The message. | |
| transformer | (displayInfo: MessageCheermote) => string | T | none | A function that transforms a message part into an arbitrary structure. |
Return type: Array<string | T>