Class ClearchatMessage

Hierarchy

ChannelIRCMessage
- ClearchatMessage

Implements

IRCMessageData

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ClearchatMessage(message: IRCMessageData): ClearchatMessage

Overrides ChannelIRCMessage.constructor
- Defined in lib/message/twitch-types/clearchat.ts:15
Parameters
- message: IRCMessageData
Returns ClearchatMessage

Properties

Readonly banDuration

banDuration: number | undefined

length in seconds (integer), undefined if permanent ban

Readonly channelName

channelName: string

Readonly ircCommand

ircCommand: string

The parser ensures this is always uppercase

Readonly ircParameters

ircParameters: string[]

Readonly ircPrefix

ircPrefix: IRCMessagePrefix | undefined

Readonly ircPrefixRaw

ircPrefixRaw: string | undefined

Readonly ircTags

ircTags: IRCMessageTags

Readonly rawSource

rawSource: string

Readonly targetUsername

targetUsername: string | undefined

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

Methods

isPermaban

isPermaban(): this is PermabanClearchatMessage

- Defined in lib/message/twitch-types/clearchat.ts:33
Returns this is PermabanClearchatMessage

isTimeout

isTimeout(): this is TimeoutClearchatMessage

- Defined in lib/message/twitch-types/clearchat.ts:29
Returns this is TimeoutClearchatMessage

wasChatCleared

wasChatCleared(): this is ClearChatClearchatMessage

- Defined in lib/message/twitch-types/clearchat.ts:25
Returns this is ClearChatClearchatMessage

Generated using TypeDoc