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

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 ChatEmote ChatEmoteList ChattersList CheermoteList ConfigError CreatedVideo EmoteSetList HelixApiGroup HelixBan HelixBanEvent HelixBitsApi HelixBitsLeaderboard HelixBitsLeaderboardEntry HelixChannel HelixChannelApi HelixChannelEditor HelixChannelEmote HelixChannelPointsApi HelixChannelSearchResult HelixChatApi HelixChatBadgeSet HelixChatBadgeVersion HelixCheermoteList HelixClip HelixClipApi HelixCustomReward HelixCustomRewardRedemption HelixEmote HelixEmoteFromSet HelixEventSubApi HelixEventSubSubscription HelixExtensionsApi HelixExtensionTransaction HelixFollow HelixGame HelixGameApi HelixHypeTrainApi HelixHypeTrainContribution HelixHypeTrainEvent HelixInstalledExtension HelixInstalledExtensionList HelixModerationApi HelixModerator HelixModeratorEvent HelixPaginatedRequest HelixPaginatedRequestWithTotal HelixPaginatedScheduleSegmentRequest HelixPoll HelixPollApi HelixPollChoice HelixPrediction HelixPredictionApi HelixPredictionOutcome HelixPredictor HelixPrivilegedUser HelixSchedule HelixScheduleApi HelixScheduleSegment HelixSearchApi HelixStream HelixStreamApi HelixStreamMarker HelixStreamMarkerWithVideo HelixSubscription HelixSubscriptionApi HelixSubscriptionEvent HelixTag HelixTagApi HelixTeam HelixTeamApi HelixTeamWithUsers HelixUser HelixUserApi HelixUserBlock HelixUserExtension HelixUserRelation HelixUserSubscription 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 CheermoteDisplayInfo CheermoteFormat HelixBanFilter HelixBitsLeaderboardQuery HelixChannelSearchFilter HelixChannelUpdate HelixClipCreateParams HelixClipData HelixClipFilter HelixCreateCustomRewardData HelixCreatePollData HelixCreatePredictionData HelixCreateScheduleSegmentData HelixCustomRewardRedemptionFilter HelixDateRangeData HelixEventSubWebHookTransportOptions HelixExtensionTransactionsFilter HelixExtensionTransactionsPaginatedFilter HelixFollowFilter HelixForwardPagination HelixGameData HelixModeratorFilter HelixPaginatedChannelSearchFilter HelixPaginatedCustomRewardRedemptionFilter HelixPaginatedResult HelixPaginatedResultWithTotal HelixPaginatedScheduleFilter HelixPaginatedScheduleResult HelixPaginatedStreamFilter HelixPaginatedVideoFilter HelixPagination HelixScheduleFilter HelixScheduleSettingsUpdate HelixScheduleSettingsUpdateVacation HelixStreamFilter HelixStreamMarkerData HelixStreamMarkerVideoData HelixUpdateCustomRewardData HelixUpdateScheduleSegmentData HelixUserBlockAdditionalInfo HelixUserExtensionUpdatePayload HelixUserExtensionUpdatePayloadActiveSlot HelixUserExtensionUpdatePayloadInactiveSlot HelixUserUpdate HelixVideoFilter HelixVideoMutedSegmentData HelixWebHookHubRequest HelixWebHookHubRequestOptions MessageCheermote TwitchCheermoteConfig UserChatInfoGlobalBadgeData VideoCreateData VideoUpdateData

Enums

CheermoteBackground CheermoteScale CheermoteState HelixBanEventType HelixBroadcasterType HelixModeratorEventType HelixStreamType HelixSubscriptionEventType HelixUserType StreamType

HelixChannelEmote

A Twitch Channel emote.

Overview

Properties

Methods

Constructor

new HelixChannelEmote(data, client)

Parameter	Type	Required	Default	Description
data	HelixChannelEmoteData		none	none
client	ApiClient		none	none

Properties

emoteSetId

Type: string

The ID of the emote set the emote is part of.

id

Type: string

The ID of the emote.

name

Type: string

The name of the emote.

tier

Type:
HelixChannelEmoteSubscriptionTier
The subscription tier necessary to unlock an emote. 1000 means tier 1, and so on.
Aliased type: "1000" | "2000" | "3000"
| null

The subscription tier necessary to unlock the emote, or null if the emote is not a subscription emote.

type

Type: string

The type of the emote.

There are many types of emotes that Twitch seems to arbitrarily assign. Do not rely on this value.

Methods

getAllEmotesFromSet()

Retrieves all emotes from the emote's set.

Return type: Array<HelixEmoteFromSet>

getImageUrl(scale)

Gets the URL of the emote image in the given scale.

Parameter	Type	Required	Default	Description
scale	HelixEmoteImageScale		none	The scale of the image.

Return type: string