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

ApiClientBadgesApiBitsApiChannelChannelApiChannelFollowChannelPlaceholderChannelSubscriptionChatApiChatBadgeListChatBadgeSetChatBadgeVersionChatEmoteChatEmoteListChattersListCheermoteListConfigErrorCreatedVideoEmoteSetListHelixApiGroupHelixBanHelixBanEventHelixBitsApiHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixChannelHelixChannelApiHelixChannelEditorHelixChannelEmoteHelixChannelPointsApiHelixChannelSearchResultHelixChatApiHelixChatBadgeSetHelixChatBadgeVersionHelixCheermoteListHelixClipHelixClipApiHelixCustomRewardHelixCustomRewardRedemptionHelixEmoteHelixEmoteFromSetHelixEventSubApiHelixEventSubSubscriptionHelixExtensionsApiHelixExtensionTransactionHelixFollowHelixGameHelixGameApiHelixHypeTrainApiHelixHypeTrainContributionHelixHypeTrainEventHelixInstalledExtensionHelixInstalledExtensionListHelixModerationApiHelixModeratorHelixModeratorEventHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPaginatedScheduleSegmentRequestHelixPollHelixPollApiHelixPollChoiceHelixPredictionHelixPredictionApiHelixPredictionOutcomeHelixPredictorHelixPrivilegedUserHelixScheduleHelixScheduleApiHelixScheduleSegmentHelixSearchApiHelixStreamHelixStreamApiHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixSubscriptionApiHelixSubscriptionEventHelixTagHelixTagApiHelixTeamHelixTeamApiHelixTeamWithUsersHelixUserHelixUserApiHelixUserBlockHelixUserExtensionHelixUserRelationHelixUserSubscriptionHelixVideoHelixVideoApiHelixWebHooksApiHelixWebHookSubscriptionKrakenApiGroupNoSubscriptionProgramErrorPrivilegedChannelPrivilegedUserSearchApiStreamStreamApiStreamNotLiveErrorSubscriptionTeamTeamApiTeamWithUsersUnsupportedApiUserUserApiUserBlockUserChatInfoUserFollowUserSubscriptionVideoVideoApi

Interfaces

ApiConfigChannelUpdateDataCheermoteDisplayInfoCheermoteFormatHelixBanFilterHelixBitsLeaderboardQueryHelixChannelSearchFilterHelixChannelUpdateHelixClipCreateParamsHelixClipDataHelixClipFilterHelixCreateCustomRewardDataHelixCreatePollDataHelixCreatePredictionDataHelixCreateScheduleSegmentDataHelixCustomRewardRedemptionFilterHelixDateRangeDataHelixEventSubWebHookTransportOptionsHelixExtensionTransactionsFilterHelixExtensionTransactionsPaginatedFilterHelixFollowFilterHelixForwardPaginationHelixGameDataHelixModeratorFilterHelixPaginatedChannelSearchFilterHelixPaginatedCustomRewardRedemptionFilterHelixPaginatedResultHelixPaginatedResultWithTotalHelixPaginatedScheduleFilterHelixPaginatedScheduleResultHelixPaginatedStreamFilterHelixPaginatedVideoFilterHelixPaginationHelixScheduleFilterHelixScheduleSettingsUpdateHelixScheduleSettingsUpdateVacationHelixStreamFilterHelixStreamMarkerDataHelixStreamMarkerVideoDataHelixUpdateCustomRewardDataHelixUpdateScheduleSegmentDataHelixUserBlockAdditionalInfoHelixUserExtensionUpdatePayloadHelixUserExtensionUpdatePayloadActiveSlotHelixUserExtensionUpdatePayloadInactiveSlotHelixUserUpdateHelixVideoFilterHelixVideoMutedSegmentDataHelixWebHookHubRequestHelixWebHookHubRequestOptionsMessageCheermoteTwitchCheermoteConfigUserChatInfoGlobalBadgeDataVideoCreateDataVideoUpdateData

Enums

CheermoteBackgroundCheermoteScaleCheermoteStateHelixBanEventTypeHelixBroadcasterTypeHelixModeratorEventTypeHelixStreamTypeHelixSubscriptionEventTypeHelixUserTypeStreamType

HelixUserExtensionUpdatePayload

The whole payload of an user extension update.

{
Component slots to update.
component?: Partial<Record<"1" | "2",
HelixUserExtensionUpdatePayloadSlot

An extension slot.

Aliased type: HelixUserExtensionUpdatePayloadInactiveSlot | HelixUserExtensionUpdatePayloadActiveSlot

>>
Overlay slots to update.
overlay?: Partial<Record<"1",
HelixUserExtensionUpdatePayloadSlot

An extension slot.

Aliased type: HelixUserExtensionUpdatePayloadInactiveSlot | HelixUserExtensionUpdatePayloadActiveSlot

>>
Panel slots to update.
panel?: Partial<Record<"1" | "2" | "3",
HelixUserExtensionUpdatePayloadSlot

An extension slot.

Aliased type: HelixUserExtensionUpdatePayloadInactiveSlot | HelixUserExtensionUpdatePayloadActiveSlot

>>
}

Properties

component

Type: ?Partial<Record<"1" | "2",
HelixUserExtensionUpdatePayloadSlot

An extension slot.

Aliased type: HelixUserExtensionUpdatePayloadInactiveSlot | HelixUserExtensionUpdatePayloadActiveSlot

>>

Component slots to update.

overlay

Type: ?Partial<Record<"1",
HelixUserExtensionUpdatePayloadSlot

An extension slot.

Aliased type: HelixUserExtensionUpdatePayloadInactiveSlot | HelixUserExtensionUpdatePayloadActiveSlot

>>

Overlay slots to update.

panel

Type: ?Partial<Record<"1" | "2" | "3",
HelixUserExtensionUpdatePayloadSlot

An extension slot.

Aliased type: HelixUserExtensionUpdatePayloadInactiveSlot | HelixUserExtensionUpdatePayloadActiveSlot

>>

Panel slots to update.