TwitchChannelInfo interface

Signature:

export interface TwitchChannelInfo 

Remarks

This is the same data as the Twitch API provides with the addition of:

isValid which you must check in the response to ensure the input was valid and Twitch was able to find the data

Properties

TwitchChannelInfo.gameId property

The id of the game being played

Signature:

readonly gameId: string;

TwitchChannelInfo.gameName property

The name of the game being played

Signature:

readonly gameName: string;

TwitchChannelInfo.id property

Twitch id of the channel / broadcaster

Signature:

readonly id: string;

TwitchChannelInfo.isLive property

Indicates if the channel is live or not

Signature:

readonly isLive: boolean;

TwitchChannelInfo.isValid property

False if the request failed

Could be a service / network outage but more likely the id was invalid

Signature:

readonly isValid: boolean;

TwitchChannelInfo.language property

Language of the channel. A language value is either the ISO 639-1 two-letter code for a supported stream language or “other”

Signature:

readonly language: string;

TwitchChannelInfo.startedAt property

When the broadcast began if live

Signature:

readonly startedAt: Date;

TwitchChannelInfo.tags property

List of tags applied to the channel

Signature:

readonly tags: string[];

TwitchChannelInfo.thumbnailUrl property

URL of a thumbnail of the broadcasters profile picture

Signature:

readonly thumbnailUrl: string;

TwitchChannelInfo.title property

Title of the channel

Signature:

readonly title: string;

TwitchChannelInfo.userLogin property

The login name of the user broadcasting the channel

Signature:

readonly userLogin: string;

TwitchChannelInfo.userName property

The display name of the user broadcasting the channel

Signature:

readonly userName: string;