Class HosttargetMessage

Hierarchy

ChannelIRCMessage
- HosttargetMessage
  - ExitHostModeHosttargetMessage
  - ExitedHostModeHosttargetMessage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new HosttargetMessage(message: IRCMessageData): HosttargetMessage

Overrides ChannelIRCMessage.constructor
- Defined in lib/message/twitch-types/hosttarget.ts:85
Parameters
- message: IRCMessageData
Returns HosttargetMessage

Properties

Readonly channelName

channelName: string

Readonly hostedChannelName

hostedChannelName: undefined | string

channel name if now hosting channel,

null if host mode was exited.

Readonly ircCommand

ircCommand: string

The parser ensures this is always uppercase

Readonly ircParameters

ircParameters: string[]

Readonly ircPrefix

ircPrefix: undefined | IRCMessagePrefix

Readonly ircPrefixRaw

ircPrefixRaw: undefined | string

Readonly ircTags

ircTags: IRCMessageTags

Readonly rawSource

rawSource: string

Readonly viewerCount

viewerCount: undefined | number

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 lib/message/twitch-types/hosttarget.ts:99
Returns this is ExitedHostModeHosttargetMessage

wasHostModeExited

wasHostModeExited(): this is ExitHostModeHosttargetMessage

- Defined in lib/message/twitch-types/hosttarget.ts:95
Returns this is ExitHostModeHosttargetMessage

Generated using TypeDoc