youtubei.js / YT / Channel

Class: Channel

Extends

• TabbedFeed<IBrowseResponse>

Constructors

new Channel()

new Channel(actions, data, already_parsed): Channel

Parameters

• actions: Actions

• data: ApiResponse | IBrowseResponse

• already_parsed: boolean = false

Returns

Channel

Overrides

TabbedFeed.constructor

Defined in

src/parser/youtube/Channel.ts:36

Properties

current_tab?

optional current_tab: Tab | ExpandableTab

Defined in

src/parser/youtube/Channel.ts:34

---

header?

optional header: C4TabbedHeader | CarouselHeader | InteractiveTabbedHeader | PageHeader

Defined in

src/parser/youtube/Channel.ts:31

---

metadata

metadata: object

android_appindexing_link?

optional android_appindexing_link: string

android_deep_link?

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

ios_appindexing_link?

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

url_applinks_android?

optional url_applinks_android: string

url_applinks_ios?

optional url_applinks_ios: string

url_applinks_web?

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

Defined in

src/parser/youtube/Channel.ts:32

---

subscribe_button?

optional subscribe_button: SubscribeButton

Defined in

src/parser/youtube/Channel.ts:33

Accessors

actions

get actions(): Actions

Returns

Actions

Inherited from

TabbedFeed.actions

Defined in

src/core/mixins/Feed.ts:180

---

channels

get channels(): ObservedArray<Channel | GridChannel>

Get all the channels in the feed

Returns

ObservedArray<Channel | GridChannel>

Inherited from

TabbedFeed.channels

Defined in

src/core/mixins/Feed.ts:125

---

content_type_filters

get content_type_filters(): string[]

Returns

string[]

Defined in

src/parser/youtube/Channel.ts:144

---

filters

get filters(): string[]

Returns

string[]

Defined in

src/parser/youtube/Channel.ts:135

---

has_about

get has_about(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:273

---

has_community

get has_community(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:269

---

has_continuation

get has_continuation(): boolean

Checks if the feed has continuation.

Returns

boolean

Inherited from

TabbedFeed.has_continuation

Defined in

src/core/mixins/Feed.ts:194

---

has_home

get has_home(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:241

---

has_live_streams

get has_live_streams(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:253

---

has_playlists

get has_playlists(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:265

---

has_podcasts

get has_podcasts(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:261

---

has_releases

get has_releases(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:257

---

has_search

get has_search(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:280

---

has_shorts

get has_shorts(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:249

---

has_videos

get has_videos(): boolean

Returns

boolean

Defined in

src/parser/youtube/Channel.ts:245

---

memo

get memo(): Memo

Returns

Memo

Inherited from

TabbedFeed.memo

Defined in

src/core/mixins/Feed.ts:136

---

page

get page(): T

Get the original page data

Returns

T

Inherited from

TabbedFeed.page

Defined in

src/core/mixins/Feed.ts:187

---

page_contents

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

Returns contents from the page.

Returns

SectionList | ReloadContinuationItemsCommand | MusicQueue | RichGrid

Inherited from

TabbedFeed.page_contents

Defined in

src/core/mixins/Feed.ts:143

---

playlists

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

Get all playlists in the feed

Returns

ObservedArray<GridPlaylist | LockupView | Playlist>

Inherited from

TabbedFeed.playlists

Defined in

src/core/mixins/Feed.ts:132

---

posts

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

Get all the community posts in the feed

Returns

ObservedArray<BackstagePost | SharedPost | Post>

Inherited from

TabbedFeed.posts

Defined in

src/core/mixins/Feed.ts:118

---

secondary_contents

get secondary_contents(): undefined | SuperParsedResult<YTNode>

Returns secondary contents from the page.

Returns

undefined | SuperParsedResult<YTNode>

Inherited from

TabbedFeed.secondary_contents

Defined in

src/core/mixins/Feed.ts:168

---

shelves

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

Returns all segments/sections from the page.

Returns

ObservedArray<ReelShelf | RichShelf | Shelf>

Inherited from

TabbedFeed.shelves

Defined in

src/core/mixins/Feed.ts:154

---

sort_filters

get sort_filters(): string[]

Returns

string[]

Defined in

src/parser/youtube/Channel.ts:139

---

tabs

get tabs(): string[]

Returns

string[]

Inherited from

TabbedFeed.tabs

Defined in

src/core/mixins/TabbedFeed.ts:19

---

title

get title(): undefined | string

Returns

undefined | string

Inherited from

TabbedFeed.title

Defined in

src/core/mixins/TabbedFeed.ts:55

---

videos

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

Get all the videos in the feed

Returns

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

Inherited from

TabbedFeed.videos

Defined in

src/core/mixins/Feed.ts:111

Methods

applyContentTypeFilter()

applyContentTypeFilter(content_type_filter): Promise<Channel>

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>

Defined in

src/parser/youtube/Channel.ts:116

---

applyFilter()

applyFilter(filter): Promise<FilteredChannelList>

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

Parameters

• filter: string | ChipCloudChip

The filter to apply

Returns

Promise<FilteredChannelList>

Defined in

src/parser/youtube/Channel.ts:65

---

applySort()

applySort(sort): Promise<Channel>

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>

Defined in

src/parser/youtube/Channel.ts:93

---

getAbout()

getAbout(): Promise<ChannelAboutFullMetadata | AboutChannel>

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

Returns

Promise<ChannelAboutFullMetadata | AboutChannel>

Defined in

src/parser/youtube/Channel.ts:193

---

getCommunity()

getCommunity(): Promise<Channel>

Returns

Promise<Channel>

Defined in

src/parser/youtube/Channel.ts:184

---

getContinuation()

getContinuation(): Promise<ChannelListContinuation>

Retrives list continuation.

Returns

Promise<ChannelListContinuation>

Overrides

TabbedFeed.getContinuation

Defined in

src/parser/youtube/Channel.ts:287

---

getContinuationData()

getContinuationData(): Promise<undefined | IBrowseResponse>

Retrieves continuation data as it is.

Returns

Promise<undefined | IBrowseResponse>

Inherited from

TabbedFeed.getContinuationData

Defined in

src/core/mixins/Feed.ts:201

---

getHome()

getHome(): Promise<Channel>

Returns

Promise<Channel>

Defined in

src/parser/youtube/Channel.ts:149

---

getLiveStreams()

getLiveStreams(): Promise<Channel>

Returns

Promise<Channel>

Defined in

src/parser/youtube/Channel.ts:164

---

getPlaylists()

getPlaylists(): Promise<Channel>

Returns

Promise<Channel>

Defined in

src/parser/youtube/Channel.ts:179

---

getPodcasts()

getPodcasts(): Promise<Channel>

Returns

Promise<Channel>

Defined in

src/parser/youtube/Channel.ts:174

---

getReleases()

getReleases(): Promise<Channel>

Returns

Promise<Channel>

Defined in

src/parser/youtube/Channel.ts:169

---

getShelf()

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

Finds shelf by title.

Parameters

• title: string

Returns

undefined | ReelShelf | RichShelf | Shelf

Inherited from

TabbedFeed.getShelf

Defined in

src/core/mixins/Feed.ts:161

---

getShorts()

getShorts(): Promise<Channel>

Returns

Promise<Channel>

Defined in

src/parser/youtube/Channel.ts:159

---

getTabByName()

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

Parameters

• title: string

Returns

Promise<TabbedFeed<IBrowseResponse>>

Inherited from

TabbedFeed.getTabByName

Defined in

src/core/mixins/TabbedFeed.ts:23

---

getTabByURL()

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

Parameters

• url: string

Returns

Promise<TabbedFeed<IBrowseResponse>>

Inherited from

TabbedFeed.getTabByURL

Defined in

src/core/mixins/TabbedFeed.ts:37

---

getVideos()

getVideos(): Promise<Channel>

Returns

Promise<Channel>

Defined in

src/parser/youtube/Channel.ts:154

---

hasTabWithURL()

hasTabWithURL(url): boolean

Parameters

• url: string

Returns

boolean

Inherited from

TabbedFeed.hasTabWithURL

Defined in

src/core/mixins/TabbedFeed.ts:51

---

search()

search(query): Promise<Channel>

Searches within the channel.

Parameters

• query: string

Returns

Promise<Channel>

Defined in

src/parser/youtube/Channel.ts:230

---

getPlaylistsFromMemo()

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

Get all playlists on a given page via memo

Parameters

• memo: Memo

Returns

ObservedArray<GridPlaylist | LockupView | Playlist>

Inherited from

TabbedFeed.getPlaylistsFromMemo

Defined in

src/core/mixins/Feed.ts:93

---

getVideosFromMemo()

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

Get all videos on a given page via memo

Parameters

• memo: Memo

Returns

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

Inherited from

TabbedFeed.getVideosFromMemo

Defined in

src/core/mixins/Feed.ts:77