dank-twitch-irc

Appearance

@mastondzn/dank-twitch-irc / ClearchatMessage

Class: ClearchatMessage ​

Extends ​

Constructors ​

new ClearchatMessage(message) ​

new ClearchatMessage(message): ClearchatMessage

Parameters ​

• message: IRCMessageData

Returns ​

ClearchatMessage

Overrides ​

ChannelIRCMessage.constructor

Source ​

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

Properties ​

banDuration ​

readonly banDuration: undefined | number

length in seconds (integer), undefined if permanent ban

Source ​

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

channelName ​

readonly channelName: string

Inherited from ​

ChannelIRCMessage.channelName

Source ​

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

ircCommand ​

readonly ircCommand: string

The parser ensures this is always uppercase

Inherited from ​

ChannelIRCMessage.ircCommand

Source ​

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

ircParameters ​

readonly ircParameters: string[]

Inherited from ​

ChannelIRCMessage.ircParameters

Source ​

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

ircPrefix ​

readonly ircPrefix: undefined | IRCMessagePrefix

Inherited from ​

ChannelIRCMessage.ircPrefix

Source ​

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

ircPrefixRaw ​

readonly ircPrefixRaw: undefined | string

Inherited from ​

ChannelIRCMessage.ircPrefixRaw

Source ​

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

ircTags ​

readonly ircTags: IRCMessageTags

Inherited from ​

ChannelIRCMessage.ircTags

Source ​

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

rawSource ​

readonly rawSource: string

Inherited from ​

ChannelIRCMessage.rawSource

Source ​

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

targetUsername ​

readonly targetUsername: undefined | string

The target username, undefined if this <code>CLEARCHAT</code> message clears the entire chat.

Source ​

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

Methods ​

isPermaban() ​

isPermaban(): this is PermabanClearchatMessage

Returns ​

this is PermabanClearchatMessage

Source ​

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

isTimeout() ​

isTimeout(): this is TimeoutClearchatMessage

Returns ​

this is TimeoutClearchatMessage

Source ​

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

wasChatCleared() ​

wasChatCleared(): this is ClearChatClearchatMessage

Returns ​

this is ClearChatClearchatMessage

Source ​

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