@mastondzn/dank-twitch-irc / ClearchatMessage

Class: ClearchatMessage

Defined in: src/message/twitch-types/clearchat.ts:5

Extends

• ChannelIRCMessage

Extended by

• ClearChatClearchatMessage
• TimeoutClearchatMessage
• PermabanClearchatMessage

Constructors

new ClearchatMessage()

new ClearchatMessage(message): ClearchatMessage

Defined in: src/message/twitch-types/clearchat.ts:17

Parameters

message

IRCMessageData

Returns

ClearchatMessage

Overrides

ChannelIRCMessage.constructor

Properties

banDuration

readonly banDuration: undefined | number

Defined in: src/message/twitch-types/clearchat.ts:15

length in seconds (integer), undefined if permanent ban

---

channelName

readonly channelName: string

Defined in: src/message/irc/channel-irc-message.ts:35

Inherited from

ChannelIRCMessage.channelName

---

ircCommand

readonly ircCommand: string

Defined in: src/message/irc/irc-message.ts:28

The parser ensures this is always uppercase

Inherited from

ChannelIRCMessage.ircCommand

---

ircParameters

readonly ircParameters: string[]

Defined in: src/message/irc/irc-message.ts:29

Inherited from

ChannelIRCMessage.ircParameters

---

ircPrefix

readonly ircPrefix: undefined | IRCMessagePrefix

Defined in: src/message/irc/irc-message.ts:23

Inherited from

ChannelIRCMessage.ircPrefix

---

ircPrefixRaw

readonly ircPrefixRaw: undefined | string

Defined in: src/message/irc/irc-message.ts:22

Inherited from

ChannelIRCMessage.ircPrefixRaw

---

ircTags

readonly ircTags: IRCMessageTags

Defined in: src/message/irc/irc-message.ts:30

Inherited from

ChannelIRCMessage.ircTags

---

rawSource

readonly rawSource: string

Defined in: src/message/irc/irc-message.ts:20

Inherited from

ChannelIRCMessage.rawSource

---

targetUsername

readonly targetUsername: undefined | string

Defined in: src/message/twitch-types/clearchat.ts:10

The target username, undefined if this CLEARCHAT message clears the entire chat.

Methods

isPermaban()

isPermaban(): this is PermabanClearchatMessage

Defined in: src/message/twitch-types/clearchat.ts:33

Returns

this is PermabanClearchatMessage

---

isTimeout()

isTimeout(): this is TimeoutClearchatMessage

Defined in: src/message/twitch-types/clearchat.ts:29

Returns

this is TimeoutClearchatMessage

---

wasChatCleared()

wasChatCleared(): this is ClearChatClearchatMessage

Defined in: src/message/twitch-types/clearchat.ts:25

Returns

this is ClearChatClearchatMessage