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

Classes

ApiClientBadgesApiBitsApiChannelChannelApiChannelFollowChannelPlaceholderChannelSubscriptionChatApiChatBadgeListChatBadgeSetChatBadgeVersionChatEmoteChatEmoteListChattersListCheermoteListConfigErrorCreatedVideoEmoteSetListHelixApiGroupHelixBanHelixBanEventHelixBitsApiHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixChannelHelixChannelApiHelixChannelEditorHelixChannelEmoteHelixChannelPointsApiHelixChannelSearchResultHelixChatApiHelixChatBadgeSetHelixChatBadgeVersionHelixCheermoteListHelixClipHelixClipApiHelixCustomRewardHelixCustomRewardRedemptionHelixEmoteHelixEmoteFromSetHelixEventSubApiHelixEventSubSubscriptionHelixExtensionsApiHelixExtensionTransactionHelixFollowHelixGameHelixGameApiHelixHypeTrainApiHelixHypeTrainContributionHelixHypeTrainEventHelixInstalledExtensionHelixInstalledExtensionListHelixModerationApiHelixModeratorHelixModeratorEventHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPaginatedScheduleSegmentRequestHelixPollHelixPollApiHelixPollChoiceHelixPredictionHelixPredictionApiHelixPredictionOutcomeHelixPredictorHelixPrivilegedUserHelixScheduleHelixScheduleApiHelixScheduleSegmentHelixSearchApiHelixStreamHelixStreamApiHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixSubscriptionApiHelixSubscriptionEventHelixTagHelixTagApiHelixTeamHelixTeamApiHelixTeamWithUsersHelixUserHelixUserApiHelixUserBlockHelixUserExtensionHelixUserRelationHelixUserSubscriptionHelixVideoHelixVideoApiHelixWebHooksApiHelixWebHookSubscriptionKrakenApiGroupNoSubscriptionProgramErrorPrivilegedChannelPrivilegedUserSearchApiStreamStreamApiStreamNotLiveErrorSubscriptionTeamTeamApiTeamWithUsersUnsupportedApiUserUserApiUserBlockUserChatInfoUserFollowUserSubscriptionVideoVideoApi

Channel

A Twitch Channel.

Overview

Properties

broadcasterLanguage

Type: string

The broadcaster's language.

broadcasterType

Type: string

The broadcaster's type, i.e. "partner", "affiliate" or "" (empty string, so neither of them).

creationDate

Type: Date

The date when the channel was created.

description

Type: string

The description of the channel.

displayName

Type: string

The display name of the channel, with proper capitalization or as Asian script.

followers

Type: number

The number of people following the channel.

game

Type: string

The game that is currently being played on the channel (or was played when it was last online).

isMature

Type: boolean

Whether the channel is flagged as suitable for mature audiences only.

isPartner

Type: boolean

Whether the channel is partnered.

language

Type: string

The language of the channel.

name

Type: string

The name of the channel.

profileBanner

Type: string | null

The URL to the profile's banner image.

profileBannerBackgroundColor

Type: string | null

The background color of the profile's banner.

status

Type: string

The current status message (i.e. the title) of the channel.

updateDate

Type: Date

The date when the channel was last updated.

url

Type: string

The URL to the channel.

videoBanner

Type: string

The URL to the channel's video banner, i.e. the offline image.

views

Type: number

The total number of views of the channel.

Methods

getTeams()

async

Retrieves a list of the teams of the channel.

Return type: Array<Team>

update(data)

async

Updates the game, title or delay of a channel or toggles the channel feed.

ParameterTypeRequiredDefaultDescription
dataChannelUpdateDatanonenone
Return type: void