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

HelixChannel

A Twitch channel.

Overview

Properties

Methods

Properties

delay

Type: number

The stream delay of the channel, in seconds.

displayName

Type: string

The display name of the channel.

gameId

Type: string

The ID of the game currently played on the channel.

gameName

Type: string

The name of the game currently played on the channel.

id

Type: string

The ID of the channel.

language

Type: string

The language of the channel.

name

Type: string

The name of the channel.

title

Type: string

The title of the channel.

Methods

getGame()

async

Retrieves information about the game that is being played on the stream.

Return type: HelixGame | null