BaseClip
Represents the base class for all clips.
Extends
Base<T>
Extended by
Type parameters
| Type parameter |
|---|
T extends EventSubConnection |
Constructors
new BaseClip()
1new BaseClip<T>(chatbot: ChatBot<T>, data: GetClip | PostCreateClip): BaseClip<T>Creates a new instance of the clip.
Parameters
| Parameter | Type | Description |
|---|---|---|
chatbot | ChatBot<T> | The current instance of the chatbot. |
data | GetClip | PostCreateClip | The data of the clip returned from the API. |
Returns
BaseClip<T>
Overrides
Base<T>.constructor
Source
twitchfy/packages/chatbot/src/structures/BaseClip.ts:28
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
chatbot | readonly | ChatBot<T> | The current instance of the chatbot. | Base.chatbot |
id | readonly | string | The id of the clip. | - |
url | readonly | string | The url of the clip. | - |
Methods
fetch()
1fetch(): Promise<null | Clip<T>>Fetches the information of the clip from the API.
Returns
Promise<null | Clip<T>>
The fetched clip. Returns null if the clip was not found (probably because it was not cached yet).
Source
twitchfy/packages/chatbot/src/structures/BaseClip.ts:47
toString()
1toString(): stringReturns
string
The url of the clip.