StreamOnline
Represents a stream online event.
Extends
Base<T>
Type parameters
| Type parameter |
|---|
T extends EventSubConnection |
Constructors
new StreamOnline()
1new StreamOnline<T>(chatbot: ChatBot<T>, data: StreamOnlineMessage<EventSubConnectionMap[T]>): StreamOnline<T>Creates a new instance of the stream online event.
Parameters
| Parameter | Type | Description |
|---|---|---|
chatbot | ChatBot<T> | The current instance of the chatbot. |
data | StreamOnlineMessage<EventSubConnectionMap[T]> | The data of the stream online event returned from the EventSub. |
Returns
StreamOnline<T>
Overrides
Base<T>.constructor
Source
twitchfy/packages/chatbot/src/structures/StreamOnline.ts:34
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
broadcaster | readonly | BaseUser<T> | The broadcaster of the channel whose stream went online. | - |
chatbot | readonly | ChatBot<T> | The current instance of the chatbot. | Base.chatbot |
stream | readonly | BaseStream<T> | The stream which went online. | - |
Accessors
broadcasterId
1get broadcasterId(): stringThe Id of the broadcaster whose stream went online.
Returns
string
Source
twitchfy/packages/chatbot/src/structures/StreamOnline.ts:44
chatroomId
1get chatroomId(): stringThe Id of the chatroom where the stream went online.
Returns
string
Source
twitchfy/packages/chatbot/src/structures/StreamOnline.ts:51
startedAt
1get startedAt(): DateReturns the time when the stream went online. A JavaScript Date object is returned.
Returns
Date