twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

Basic usage

Getting startedConnecting to ChatListening to events

Upgrading

Upgrading to 2.xUpgrading to 3.xUpgrading to 4.x

Examples

Basic botPreventing sub gift spam

Classes

ChatClientChatUserTwitchPrivateMessageUserNotice

Interfaces

BaseChatClientOptionsChatBitsBadgeUpgradeInfoChatCommunityPayForwardInfoChatCommunitySubInfoChatPrimeCommunityGiftInfoChatRaidInfoChatRewardGiftInfoChatRitualInfoChatSayMessageAttributesChatStandardPayForwardInfoChatSubExtendInfoChatSubGiftInfoChatSubGiftUpgradeInfoChatSubInfoChatSubUpgradeInfoParsedMessageCheerPartParsedMessageEmotePartParsedMessageTextPartTcpChatClientOptionsWebSocketChatClientOptions

TwitchPrivateMessage

An IRC PRIVMSG, with easy accessors for commonly used data from its tags.

Overview

Properties

Methods

Properties

bits

Type: number

The number of bits cheered with the message.

channelId

Type: string | null

The ID of the channel the message is in.

emoteOffsets

Type: Map<string, Array<string>>

The offsets of emote usages in the message.

id

Type: string

The ID of the message.

isCheer

Type: boolean

Whether the message is a cheer.

totalBits

Type: number

Deprecated.

Use TwitchPrivateMessage#bits instead.

The number of bits cheered with the message.

userInfo

Type: ChatUser

Info about the user that send the message, like their user ID and their status in the current channel.

Methods

parseEmotes()

Parses the message, separating text from emote usages.

Return type: Array<
ParsedMessagePart

Aliased type: ParsedMessageTextPart | ParsedMessageCheerPart | ParsedMessageEmotePart

>

parseEmotesAndBits(cheermotes)

Parses the message, separating text from emote usages and cheers.

ParameterTypeRequiredDefaultDescription
cheermotesCheermoteListnone

A list of cheermotes

Return type: Array<
ParsedMessagePart

Aliased type: ParsedMessageTextPart | ParsedMessageCheerPart | ParsedMessageEmotePart

>