Skip to content

BaseStream

The base class representing an stream structure.

Extends

Type parameters

Type parameterValue
T extends SubscriptionTypes-
K extends ConnectionTypesConnectionTypes

Constructors

new BaseStream()

1
new BaseStream<T, K>(
2
connection: K,
3
subscription: SubscriptionType<T, K>,
4
data: BaseStreamData): BaseStream<T, K>

Builds up a BaseStream.

Parameters

ParameterTypeDescription
connectionKThe EventSub connection used.
subscriptionSubscriptionType<T, K>The subscription which trigger this message.
dataBaseStreamDataThe event data received with the subscription.

Returns

BaseStream<T, K>

Overrides

Base.constructor

Source

twitchfy/packages/eventsub/src/structures/messages/BaseStream.ts:32

Properties

PropertyModifierTypeDescriptionInherited from
connectionreadonlyKThe EventSub connection used.Base.connection
idreadonlystringThe ID of the stream.-
startedAtreadonlyDateThe Date object when the stream started.-
subscriptionreadonlySubscriptionType<T, K>The subscription which trigger this message.Base.subscription
typereadonlyStreamTypesThe type of the stream. Currently, it can only be ‘live’.-