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

HelixChannelSearchResult

The result of a channel search.

Overview

Properties

displayName

Type: string

The display name of the channel.

gameId

Type: string

The ID of the game currently played on the channel.

id

Type: string

The ID of the channel.

isLive

Type: boolean

Whether the channel is currently live.

language

Type: string

The language of the channel.

name

Type: string

The name of the channel.

startDate

Type: Date | null

The start date of the stream. Returns null if the stream is not live.

tagIds

Type: Array<string>

The IDs of the tags set on the channel.

thumbnailUrl

Type: string

The thumbnail URL of the stream.

Methods

getGame()

async

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

Return type: HelixGame | null

getTags()

async

Retrieves the tags of the channel.

Return type: Array<HelixTag>

getUser()

async

Retrieves additional information about the owner of the channel.

Return type: HelixUser | null