Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

Constructors

Properties

badgeInfo: TwitchBadgesList
badgeInfoRaw: string
badgesRaw: string
bits: undefined | number
bitsRaw: undefined | string
channelID: string
channelName: string
color: undefined | Color
colorRaw: string
displayName: string
emotesRaw: string
flags: undefined | TwitchFlagList

Can be an array of Twitch AutoMod flagged words, for use in moderation and/or filtering purposes.

If the flags tag is missing or of a unparseable format, this will be undefined. This is unlike most other attributes which when missing or malformed will fail the message parsing. However since this attribute is completely undocumented we cannot rely on the flags tag being stable, so this soft fallback is used instead. While it will be a major version release if this attribute changes format in dank-twitch-irc, using this is still at your own risk since it may suddenly contain unexpected data or turn undefined one day as Twitch changes something. In short: Use at your own risk and make sure your implementation can handle the case where this is undefined.

flagsRaw: undefined | string

Twitch AutoMod raw flags string.

If the flags tag is missing or of a unparseable format, this will be undefined. This is unlike most other attributes which when missing or malformed will fail the message parsing. However since this attribute is completely undocumented we cannot rely on the flags tag being stable, so this soft fallback is used instead. In short, ensure your implementation can handle the case where this is undefined or is in a format you don't expect.

ircCommand: string

The parser ensures this is always uppercase

ircParameters: string[]
ircPrefix: undefined | IRCMessagePrefix
ircPrefixRaw: undefined | string
isAction: boolean
isMod: boolean
isModRaw: string
messageID: string
messageText: string
rawSource: string
replyParentDisplayName: undefined | string
replyParentMessageBody: undefined | string
replyParentMessageID: undefined | string
replyParentUserID: undefined | string
replyParentUserLogin: undefined | string
senderUserID: string
senderUsername: string
serverTimestamp: Date
serverTimestampRaw: string

Methods

  • isCheer(): this is CheerPrivmsgMessage
  • isReply(): this is ReplyPrivmsgMessage

Generated using TypeDoc