parseEmotes

Convert a message with emote codes into a message with emote images

Example

import { parseEmotes } from "emotettv";

const parsedMessage = await parseEmotes(
    "hello world! VoHiYo",
    { "81274": [13-18] },
    { channelId: "98776633" }
);
const messageArr = parsedMessage.toArray();
console.log(messageArr);

API

parseEmotes(...)

parseEmotes: (
    message: string,
    _emotePositions?: EmotePositions | null,
    _options?: Partial<ParserOptions> | null
) => Promise<{
    toArray: () => ParsedEmotesMessage;
    toHTML: (scale?: number, inlineStyles?: boolean, escapeHTML?: boolean) => string;
}>

Parse emotes in a message and return multiple methods to manage the results.

Returns: Promise<{toArray(), toHTML(...)}>

.toArray()

toArray: () => ParsedEmotesMessage;

Converts parsed message into an array of words and emotes.

Returns: ParsedEmotesMessage

.toHTML(...)

toHTML: (scale?: number, inlineStyles?: boolean, escapeHTML?: boolean) => string;

Converts parsed message into a ready-to-use HTML string.

Returns: string

Types

EmotePositions

This is the same type used by TMI.js when returning emote offsets, so you can use it directly when needed.

Object map of:

ParsedEmotesMessage

Array of:

ParsedEmote

ParsedOverlay

ParserOptions

Providers

You can also add any providers you create. See custom emotes/badges guide for more information.

PreviousparseBadges

Last updated