StreamOfflineMessage

The message received by the StreamOffline event.

Extends

• BaseSubscriptionMessage<SubscriptionTypes.StreamOffline, K>

Type parameters

Type parameter	Value
K extends ConnectionTypes	ConnectionTypes

Constructors

new StreamOfflineMessage()

new StreamOfflineMessage<K>(
   connection: K,
   subscription: SubscriptionType<StreamOffline, K>,
data: StreamOfflineEvent): StreamOfflineMessage<K>

Builds up a StreamOffline message.

Parameters

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

Returns

StreamOfflineMessage<K>

Overrides

BaseSubscriptionMessage.constructor

Source

twitchfy/packages/eventsub/src/structures/messages/StreamOffline/StreamOfflineMessage.ts:24

Properties

Property	Modifier	Type	Description	Inherited from
broadcaster	readonly	BaseUser<StreamOffline, K>	The broadcaster of the stream which went offline.	-
connection	readonly	K	The EventSub connection used.	BaseSubscriptionMessage.connection
subscription	readonly	SubscriptionType<StreamOffline, 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