StreamOnlineMessage

The message received by the StreamOnline event.

Extends

• BaseSubscriptionMessage<SubscriptionTypes.StreamOnline, K>

Type parameters

Type parameter	Value
K extends ConnectionTypes	ConnectionTypes

Constructors

new StreamOnlineMessage()

new StreamOnlineMessage<K>(
   connection: K,
   subscription: SubscriptionType<StreamOnline, K>,
data: StreamOnlineEvent): StreamOnlineMessage<K>

Builds up a StreamOnline message.

Parameters

Parameter	Type	Description
connection	K	The EventSub connection used.
subscription	SubscriptionType<StreamOnline, K>	The subscription which trigger this message.
data	StreamOnlineEvent	The event data received with the subscription.

Returns

StreamOnlineMessage<K>

Overrides

BaseSubscriptionMessage.constructor

Source

twitchfy/packages/eventsub/src/structures/messages/StreamOnline/StreamOnlineMessage.ts:28

Properties

Property	Modifier	Type	Description	Inherited from
broadcaster	readonly	BaseUser<StreamOnline, K>	The broadcaster of the stream which went online.	-
connection	readonly	K	The EventSub connection used.	BaseSubscriptionMessage.connection
stream	readonly	BaseStream<StreamOnline, K>	The stream which went online.	-
subscription	readonly	SubscriptionType<StreamOnline, K>	The subscription which trigger this message.	BaseSubscriptionMessage.subscription

Methods

checkMessageType()

checkMessageType<U>(type: U): this is SubscriptionMessages<K>[U]

Checks whether the message is of a certain type.

Type parameters

Type parameter	Value
U extends SubscriptionTypes	SubscriptionTypes

Parameters

Parameter	Type	Description
type	U	The type to check.

Returns

this is SubscriptionMessages<K>[U]

Whether the message is of the type.

Inherited from

BaseSubscriptionMessage.checkMessageType

Source

twitchfy/packages/eventsub/src/structures/messages/BaseSubscriptionMessage.ts:24