youtubei.js / YT / Channel

Class: Channel

Defined in: src/parser/youtube/Channel.ts:36

Extends

Constructors

Constructor

new Channel(actions, data, already_parsed): Channel

Defined in: src/parser/youtube/Channel.ts:42

Parameters

actions

Actions

data

ApiResponse | IBrowseResponse

already_parsed

boolean = false

Returns

Channel

Overrides

TabbedFeed.constructor

Properties

current_tab?

optional current_tab: Tab | ExpandableTab

Defined in: src/parser/youtube/Channel.ts:40

optional header: C4TabbedHeader | CarouselHeader | InteractiveTabbedHeader | PageHeader

Defined in: src/parser/youtube/Channel.ts:37

metadata

metadata: object

Defined in: src/parser/youtube/Channel.ts:38

optional android_appindexing_link: string

optional android_deep_link: string

android_package?

optional android_package: string

app_name?

optional app_name: string

available_countries?

optional available_countries: string[]

avatar?

optional avatar: Thumbnail[]

description?

optional description: string

external_id?

optional external_id: string

ios_app_arguments?

optional ios_app_arguments: string

ios_app_store_id?

optional ios_app_store_id: string

optional ios_appindexing_link: string

is_family_safe?

optional is_family_safe: boolean

is_unlisted?

optional is_unlisted: boolean

keywords?

optional keywords: string[]

music_artist_name?

optional music_artist_name: string

noindex?

optional noindex: string

og_type?

optional og_type: string

rss_url?

optional rss_url: string

schema_dot_org_type?

optional schema_dot_org_type: string

site_name?

optional site_name: string

tags?

optional tags: string[]

thumbnail?

optional thumbnail: Thumbnail[]

title?

optional title: string

twitter_card_type?

optional twitter_card_type: string

twitter_site_handle?

optional twitter_site_handle: string

type?

readonly optional type: string

url?

optional url: string

optional url_applinks_android: string

optional url_applinks_ios: string

optional url_applinks_web: string

url_canonical?

optional url_canonical: string

url_twitter_android?

optional url_twitter_android: string

url_twitter_ios?

optional url_twitter_ios: string

vanity_channel_url?

optional vanity_channel_url: string

subscribe_button?

optional subscribe_button: SubscribeButton

Defined in: src/parser/youtube/Channel.ts:39

Accessors

actions

Get Signature

get actions(): Actions

Defined in: src/core/mixins/Feed.ts:181

Returns

Actions

Inherited from

TabbedFeed.actions

channels

Get Signature

get channels(): ObservedArray<Channel | GridChannel>

Defined in: src/core/mixins/Feed.ts:126

Get all the channels in the feed

Returns

ObservedArray<Channel | GridChannel>

Inherited from

TabbedFeed.channels

content_type_filters

Get Signature

get content_type_filters(): string[]

Defined in: src/parser/youtube/Channel.ts:151

Returns

string[]

filters

Get Signature

get filters(): string[]

Defined in: src/parser/youtube/Channel.ts:142

Returns

string[]

has_about

Get Signature

get has_about(): boolean

Defined in: src/parser/youtube/Channel.ts:289

Returns

boolean

has_community

Get Signature

get has_community(): boolean

Defined in: src/parser/youtube/Channel.ts:285

Returns

boolean

has_continuation

Get Signature

get has_continuation(): boolean

Defined in: src/core/mixins/Feed.ts:195

Checks if the feed has continuation.

Returns

boolean

Inherited from

TabbedFeed.has_continuation

has_courses

Get Signature

get has_courses(): boolean

Defined in: src/parser/youtube/Channel.ts:277

Returns

boolean

has_home

Get Signature

get has_home(): boolean

Defined in: src/parser/youtube/Channel.ts:253

Returns

boolean

has_live_streams

Get Signature

get has_live_streams(): boolean

Defined in: src/parser/youtube/Channel.ts:265

Returns

boolean

has_playlists

Get Signature

get has_playlists(): boolean

Defined in: src/parser/youtube/Channel.ts:281

Returns

boolean

has_podcasts

Get Signature

get has_podcasts(): boolean

Defined in: src/parser/youtube/Channel.ts:273

Returns

boolean

has_releases

Get Signature

get has_releases(): boolean

Defined in: src/parser/youtube/Channel.ts:269

Returns

boolean

Get Signature

get has_search(): boolean

Defined in: src/parser/youtube/Channel.ts:296

Returns

boolean

has_shorts

Get Signature

get has_shorts(): boolean

Defined in: src/parser/youtube/Channel.ts:261

Returns

boolean

has_videos

Get Signature

get has_videos(): boolean

Defined in: src/parser/youtube/Channel.ts:257

Returns

boolean

memo

Get Signature

get memo(): Memo

Defined in: src/core/mixins/Feed.ts:137

Returns

Memo

Inherited from

TabbedFeed.memo

page

Get Signature

get page(): T

Defined in: src/core/mixins/Feed.ts:188

Get the original page data

Returns

T

Inherited from

TabbedFeed.page

page_contents

Get Signature

get page_contents(): SectionList | MusicQueue | RichGrid | ReloadContinuationItemsCommand

Defined in: src/core/mixins/Feed.ts:144

Returns contents from the page.

Returns

SectionList | MusicQueue | RichGrid | ReloadContinuationItemsCommand

Inherited from

TabbedFeed.page_contents

playlists

Get Signature

get playlists(): ObservedArray<GridPlaylist | LockupView | Playlist>

Defined in: src/core/mixins/Feed.ts:133

Get all playlists in the feed

Returns

ObservedArray<GridPlaylist | LockupView | Playlist>

Inherited from

TabbedFeed.playlists

posts

Get Signature

get posts(): ObservedArray<BackstagePost | Post | SharedPost>

Defined in: src/core/mixins/Feed.ts:119

Get all the community posts in the feed

Returns

ObservedArray<BackstagePost | Post | SharedPost>

Inherited from

TabbedFeed.posts

secondary_contents

Get Signature

get secondary_contents(): SectionList | BrowseFeedActions | ProfileColumn | SecondarySearchContainer | null

Defined in: src/core/mixins/Feed.ts:169

Returns secondary contents from the page.

Returns

SectionList | BrowseFeedActions | ProfileColumn | SecondarySearchContainer | null

Inherited from

TabbedFeed.secondary_contents

shelves

Get Signature

get shelves(): ObservedArray<ReelShelf | RichShelf | Shelf>

Defined in: src/core/mixins/Feed.ts:155

Returns all segments/sections from the page.

Returns

ObservedArray<ReelShelf | RichShelf | Shelf>

Inherited from

TabbedFeed.shelves

sort_filters

Get Signature

get sort_filters(): string[]

Defined in: src/parser/youtube/Channel.ts:146

Returns

string[]

tabs

Get Signature

get tabs(): string[]

Defined in: src/core/mixins/TabbedFeed.ts:19

Returns

string[]

Inherited from

TabbedFeed.tabs

title

Get Signature

get title(): string | undefined

Defined in: src/core/mixins/TabbedFeed.ts:55

Returns

string | undefined

Inherited from

TabbedFeed.title

videos

Get Signature

get videos(): ObservedArray<CompactVideo | GridVideo | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Defined in: src/core/mixins/Feed.ts:112

Get all the videos in the feed

Returns

ObservedArray<CompactVideo | GridVideo | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Inherited from

TabbedFeed.videos

Methods

applyContentTypeFilter()

applyContentTypeFilter(content_type_filter): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:123

Applies given content type filter to the list. Use content_type_filters to get available filters.

Parameters

content_type_filter

string

The content type filter to apply

Returns

Promise<Channel>

applyFilter()

applyFilter(filter): Promise<FilteredChannelList>

Defined in: src/parser/youtube/Channel.ts:72

Applies given filter to the list. Use filters to get available filters.

Parameters

filter

The filter to apply

string | ChipCloudChip

Returns

Promise<FilteredChannelList>

applySort()

applySort(sort): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:100

Applies given sort filter to the list. Use sort_filters to get available filters.

Parameters

sort

string

The sort filter to apply

Returns

Promise<Channel>

getAbout()

getAbout(): Promise<ChannelAboutFullMetadata | AboutChannel>

Defined in: src/parser/youtube/Channel.ts:205

Retrieves the about page. Note that this does not return a new Channel object.

Returns

Promise<ChannelAboutFullMetadata | AboutChannel>

getCommunity()

getCommunity(): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:196

Returns

Promise<Channel>

getContinuation()

getContinuation(): Promise<ChannelListContinuation>

Defined in: src/parser/youtube/Channel.ts:300

Retrieves next batch of contents and returns a new Feed object.

Returns

Promise<ChannelListContinuation>

Overrides

TabbedFeed.getContinuation

getContinuationData()

getContinuationData(): Promise<IBrowseResponse | undefined>

Defined in: src/core/mixins/Feed.ts:202

Retrieves continuation data as it is.

Returns

Promise<IBrowseResponse | undefined>

Inherited from

TabbedFeed.getContinuationData

getCourses()

getCourses(): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:186

Returns

Promise<Channel>

getHome()

getHome(): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:156

Returns

Promise<Channel>

getLiveStreams()

getLiveStreams(): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:171

Returns

Promise<Channel>

getPlaylists()

getPlaylists(): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:191

Returns

Promise<Channel>

getPodcasts()

getPodcasts(): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:181

Returns

Promise<Channel>

getReleases()

getReleases(): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:176

Returns

Promise<Channel>

getShelf()

getShelf(title): ReelShelf | RichShelf | Shelf | undefined

Defined in: src/core/mixins/Feed.ts:162

Finds shelf by title.

Parameters

title

string

Returns

ReelShelf | RichShelf | Shelf | undefined

Inherited from

TabbedFeed.getShelf

getShorts()

getShorts(): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:166

Returns

Promise<Channel>

getTabByName()

getTabByName(title): Promise<TabbedFeed<IBrowseResponse>>

Defined in: src/core/mixins/TabbedFeed.ts:23

Parameters

title

string

Returns

Promise<TabbedFeed<IBrowseResponse>>

Inherited from

TabbedFeed.getTabByName

getTabByURL()

getTabByURL(url): Promise<TabbedFeed<IBrowseResponse>>

Defined in: src/core/mixins/TabbedFeed.ts:37

Parameters

url

string

Returns

Promise<TabbedFeed<IBrowseResponse>>

Inherited from

TabbedFeed.getTabByURL

getVideos()

getVideos(): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:161

Returns

Promise<Channel>

hasTabWithURL()

hasTabWithURL(url): boolean

Defined in: src/core/mixins/TabbedFeed.ts:51

Parameters

url

string

Returns

boolean

Inherited from

TabbedFeed.hasTabWithURL

search(query): Promise<Channel>

Defined in: src/parser/youtube/Channel.ts:242

Searches within the channel.

Parameters

query

string

Returns

Promise<Channel>

getPlaylistsFromMemo()

static getPlaylistsFromMemo(memo): ObservedArray<GridPlaylist | LockupView | Playlist>

Defined in: src/core/mixins/Feed.ts:94

Get all playlists on a given page via memo

Parameters

memo

Memo

Returns

ObservedArray<GridPlaylist | LockupView | Playlist>

Inherited from

TabbedFeed.getPlaylistsFromMemo

getVideosFromMemo()

static getVideosFromMemo(memo): ObservedArray<CompactVideo | GridVideo | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Defined in: src/core/mixins/Feed.ts:78

Get all videos on a given page via memo

Parameters

memo

Memo

Returns

ObservedArray<CompactVideo | GridVideo | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Inherited from

TabbedFeed.getVideosFromMemo