dank-twitch-irc

Appearance

@mastondzn/dank-twitch-irc / ClearchatMessage

Class: ClearchatMessage ​

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

Extends ​

Extended by ​

Constructors ​

Constructor ​

new ClearchatMessage(message): ClearchatMessage

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

Parameters ​

message ​

IRCMessageData

Returns ​

ClearchatMessage

Overrides ​

ChannelIRCMessage.constructor

Properties ​

_channelLogin ​

protected readonly _channelLogin: string

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

Inherited from ​

ChannelIRCMessage._channelLogin

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: IRCMessagePrefix | undefined

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

Inherited from ​

ChannelIRCMessage.ircPrefix

ircPrefixRaw ​

readonly ircPrefixRaw: string | undefined

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

Accessors ​

banDuration ​

Get Signature ​

get banDuration(): number | undefined

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

length in seconds (integer), undefined if permanent ban

Returns ​

number | undefined

channel ​

Get Signature ​

get channel(): Channel

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

Returns ​

Channel

Inherited from ​

ChannelIRCMessage.channel

channelName ​

Get Signature ​

get channelName(): string

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

Deprecated ​

Use channel.login instead.

Returns ​

string

Inherited from ​

ChannelIRCMessage.channelName

target ​

Get Signature ​

get target(): ClearchatTarget

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

Returns ​

ClearchatTarget

targetUsername ​

Get Signature ​

get targetUsername(): string | undefined

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

Deprecated ​

Use target.login instead.

Returns ​

string | undefined

Methods ​

isPermaban() ​

isPermaban(): this is PermabanClearchatMessage

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

Returns ​

this is PermabanClearchatMessage

isTimeout() ​

isTimeout(): this is TimeoutClearchatMessage

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

Returns ​

this is TimeoutClearchatMessage

wasChatCleared() ​

wasChatCleared(): this is ClearChatClearchatMessage

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

Returns ​

this is ClearChatClearchatMessage