twitch easy-twitch-bot twitch-auth twitch-auth-tmi twitch-chat-client twitch-eventsub twitch-pubsub-client twitch-webhooks

Welcome

Basic usage

Getting started Creating a client instance Calling the Twitch API FAQ

Upgrading

Upgrading to 2.x Upgrading to 3.x Upgrading to 4.x

Classes

ApiClient BadgesApi BitsApi Channel ChannelApi ChannelFollow ChannelPlaceholder ChannelSubscription ChatApi ChatBadgeList ChatBadgeSet ChatBadgeVersion ChatEmoteList ChattersList CheermoteList ConfigError CreatedVideo EmoteSetList HelixApiGroup HelixBan HelixBanEvent HelixBitsApi HelixBitsLeaderboard HelixBitsLeaderboardEntry HelixChannel HelixChannelApi HelixChannelEditor HelixChannelPointsApi HelixChannelSearchResult HelixCheermoteList HelixClip HelixClipApi HelixCustomReward HelixCustomRewardRedemption HelixEventSubApi HelixEventSubSubscription HelixExtensionsApi HelixExtensionTransaction HelixFollow HelixGame HelixGameApi HelixHypeTrainApi HelixHypeTrainContribution HelixHypeTrainEvent HelixInstalledExtension HelixInstalledExtensionList HelixModerationApi HelixModerator HelixModeratorEvent HelixPaginatedRequest HelixPaginatedRequestWithTotal HelixPrivilegedUser HelixSearchApi HelixStream HelixStreamApi HelixStreamMarker HelixStreamMarkerWithVideo HelixSubscription HelixSubscriptionApi HelixSubscriptionEvent HelixTag HelixTagApi HelixTeam HelixTeamApi HelixTeamWithUsers HelixUser HelixUserApi HelixUserBlock HelixUserExtension HelixUserRelation HelixVideo HelixVideoApi HelixWebHooksApi HelixWebHookSubscription KrakenApiGroup NoSubscriptionProgramError PrivilegedChannel PrivilegedUser SearchApi Stream StreamApi StreamNotLiveError Subscription Team TeamApi TeamWithUsers UnsupportedApi User UserApi UserBlock UserChatInfo UserFollow UserSubscription Video VideoApi

Interfaces

ApiConfig ChannelUpdateData HelixBanFilter HelixBitsLeaderboardQuery HelixChannelSearchFilter HelixChannelUpdate HelixClipCreateParams HelixClipFilter HelixCreateCustomRewardData HelixCustomRewardRedemptionFilter HelixEventSubWebHookTransportOptions HelixExtensionTransactionsFilter HelixExtensionTransactionsPaginatedFilter HelixFollowFilter HelixForwardPagination HelixModeratorFilter HelixPaginatedChannelSearchFilter HelixPaginatedCustomRewardRedemptionFilter HelixPaginatedResponse HelixPaginatedResponseWithTotal HelixPaginatedResult HelixPaginatedResultWithTotal HelixPaginatedStreamFilter HelixPaginatedVideoFilter HelixPagination HelixStreamFilter HelixUpdateCustomRewardData HelixUserBlockAdditionalInfo HelixUserExtensionUpdatePayload HelixUserExtensionUpdatePayloadActiveSlot HelixUserExtensionUpdatePayloadInactiveSlot HelixUserUpdate HelixVideoFilter HelixWebHookHubRequest HelixWebHookHubRequestOptions VideoCreateData VideoUpdateData

Enums

HelixBanEventType HelixBroadcasterType HelixModeratorEventType HelixStreamType HelixSubscriptionEventType StreamType

HelixClip

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster of the stream where the clip was created.

broadcasterId

Type: string

The user ID of the broadcaster of the stream where the clip was created.

creationDate

Type: Date

The date when the clip was created.

creatorDisplayName

Type: string

The display name of the creator of the clip.

creatorId

Type: string

The user ID of the creator of the clip.

embedUrl

Type: string

The embed URL of the clip.

gameId

Type: string

The ID of the game that was being played when the clip was created.

id

Type: string

The clip ID.

language

Type: string

The language of the stream where the clip was created.

thumbnailUrl

Type: string

The URL of the thumbnail of the clip.

title

Type: string

The title of the clip.

url

Type: string

The URL of the clip.

videoId

Type: string

The ID of the video the clip is taken from.

views

Type: number

The number of views of the clip.

Methods

getBroadcaster()

async

Retrieves information about the broadcaster of the stream where the clip was created.

Return type: HelixUser | null

getCreator()

async

Retrieves information about the creator of the clip.

Return type: HelixUser | null

getGame()

async

Retrieves information about the game that was being played when the clip was created.

Return type: HelixGame | null

getVideo()

async

Retrieves information about the video the clip is taken from.

Return type: HelixVideo | null