Skip to content

@mastondzn/dank-twitch-irc / HosttargetMessage

Class: HosttargetMessage

Defined in: src/message/twitch-types/hosttarget.ts:66

Extends

Extended by

Constructors

new HosttargetMessage()

new HosttargetMessage(message): HosttargetMessage

Defined in: src/message/twitch-types/hosttarget.ts:81

Parameters

message

IRCMessageData

Returns

HosttargetMessage

Overrides

ChannelIRCMessage.constructor

Properties

channelName

readonly channelName: string

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

Inherited from

ChannelIRCMessage.channelName


hostedChannelName

readonly hostedChannelName: undefined | string

Defined in: src/message/twitch-types/hosttarget.ts:72

channel name if now hosting channel,

null if host mode was exited.


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


viewerCount

readonly viewerCount: undefined | number

Defined in: src/message/twitch-types/hosttarget.ts:79

The viewer count of the enabled host.

null if viewercount is unknown or host mode was exited.

Methods

wasHostModeEntered()

wasHostModeEntered(): this is ExitedHostModeHosttargetMessage

Defined in: src/message/twitch-types/hosttarget.ts:95

Returns

this is ExitedHostModeHosttargetMessage


wasHostModeExited()

wasHostModeExited(): this is ExitHostModeHosttargetMessage

Defined in: src/message/twitch-types/hosttarget.ts:91

Returns

this is ExitHostModeHosttargetMessage