twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

Basic usage

Getting startedCreating a client instanceCalling the Twitch APIFAQ

Upgrading

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

Classes

ApiClientBadgesApiBitsApiChannelChannelApiChannelFollowChannelPlaceholderChannelSubscriptionChatApiChatBadgeListChatBadgeSetChatBadgeVersionChatEmoteListChattersListCheermoteListConfigErrorCreatedVideoEmoteSetListHelixApiGroupHelixBanHelixBanEventHelixBitsApiHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixChannelHelixChannelApiHelixChannelEditorHelixChannelPointsApiHelixChannelSearchResultHelixCheermoteListHelixClipHelixClipApiHelixCustomRewardHelixCustomRewardRedemptionHelixEventSubApiHelixEventSubSubscriptionHelixExtensionsApiHelixExtensionTransactionHelixFollowHelixGameHelixGameApiHelixHypeTrainApiHelixHypeTrainContributionHelixHypeTrainEventHelixInstalledExtensionHelixInstalledExtensionListHelixModerationApiHelixModeratorHelixModeratorEventHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPrivilegedUserHelixSearchApiHelixStreamHelixStreamApiHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixSubscriptionApiHelixSubscriptionEventHelixTagHelixTagApiHelixTeamHelixTeamApiHelixTeamWithUsersHelixUserHelixUserApiHelixUserBlockHelixUserExtensionHelixUserRelationHelixVideoHelixVideoApiHelixWebHooksApiHelixWebHookSubscriptionKrakenApiGroupNoSubscriptionProgramErrorPrivilegedChannelPrivilegedUserSearchApiStreamStreamApiStreamNotLiveErrorSubscriptionTeamTeamApiTeamWithUsersUnsupportedApiUserUserApiUserBlockUserChatInfoUserFollowUserSubscriptionVideoVideoApi

Interfaces

ApiConfigChannelUpdateDataHelixBanFilterHelixBitsLeaderboardQueryHelixChannelSearchFilterHelixChannelUpdateHelixClipCreateParamsHelixClipFilterHelixCreateCustomRewardDataHelixCustomRewardRedemptionFilterHelixEventSubWebHookTransportOptionsHelixExtensionTransactionsFilterHelixExtensionTransactionsPaginatedFilterHelixFollowFilterHelixForwardPaginationHelixModeratorFilterHelixPaginatedChannelSearchFilterHelixPaginatedCustomRewardRedemptionFilterHelixPaginatedResponseHelixPaginatedResponseWithTotalHelixPaginatedResultHelixPaginatedResultWithTotalHelixPaginatedStreamFilterHelixPaginatedVideoFilterHelixPaginationHelixStreamFilterHelixUpdateCustomRewardDataHelixUserBlockAdditionalInfoHelixUserExtensionUpdatePayloadHelixUserExtensionUpdatePayloadActiveSlotHelixUserExtensionUpdatePayloadInactiveSlotHelixUserUpdateHelixVideoFilterHelixWebHookHubRequestHelixWebHookHubRequestOptionsVideoCreateDataVideoUpdateData

Enums

HelixBanEventTypeHelixBroadcasterTypeHelixModeratorEventTypeHelixStreamTypeHelixSubscriptionEventTypeStreamType

HelixHypeTrainContribution

A Hype Train contributor.

Overview

Properties

Methods

Properties

total

Type: number

The total contribution amount in subs or bits.

type

Type:
HelixHypeTrainContributionType

The type of a Hype Train contribution.

Aliased type: "BITS" | "SUBS"

The Hype Train event type.

userId

Type: string

The ID of the user contributing to the Hype Train.

Methods

getUser()

async

Retrieves additional information about the user contributing to the Hype Train.

Return type: HelixUser | null