youtubei.js / YTKids / HomeFeed

Class: HomeFeed

Extends

• Feed<IBrowseResponse>

Constructors

new HomeFeed()

new HomeFeed(actions, data, already_parsed): HomeFeed

Parameters

• actions: Actions

• data: ApiResponse | IBrowseResponse

• already_parsed: boolean = false

Returns

HomeFeed

Overrides

Feed.constructor

Defined in

src/parser/ytkids/HomeFeed.ts:15

Properties

contents?

optional contents: KidsHomeScreen

Defined in

src/parser/ytkids/HomeFeed.ts:13

---

header?

optional header: KidsCategoriesHeader

Defined in

src/parser/ytkids/HomeFeed.ts:12

Accessors

actions

get actions(): Actions

Returns

Actions

Inherited from

Feed.actions

Defined in

src/core/mixins/Feed.ts:180

---

categories

get categories(): string[]

Returns

string[]

Defined in

src/parser/ytkids/HomeFeed.ts:46

---

channels

get channels(): ObservedArray<Channel | GridChannel>

Get all the channels in the feed

Returns

ObservedArray<Channel | GridChannel>

Inherited from

Feed.channels

Defined in

src/core/mixins/Feed.ts:125

---

has_continuation

get has_continuation(): boolean

Checks if the feed has continuation.

Returns

boolean

Inherited from

Feed.has_continuation

Defined in

src/core/mixins/Feed.ts:194

---

memo

get memo(): Memo

Returns

Memo

Inherited from

Feed.memo

Defined in

src/core/mixins/Feed.ts:136

---

page

get page(): T

Get the original page data

Returns

T

Inherited from

Feed.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

Feed.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

Feed.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

Feed.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

Feed.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

Feed.shelves

Defined in

src/core/mixins/Feed.ts:154

---

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

Feed.videos

Defined in

src/core/mixins/Feed.ts:111

Methods

getContinuation()

getContinuation(): Promise<Feed<IBrowseResponse>>

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

Returns

Promise<Feed<IBrowseResponse>>

Inherited from

Feed.getContinuation

Defined in

src/core/mixins/Feed.ts:220

---

getContinuationData()

getContinuationData(): Promise<undefined | IBrowseResponse>

Retrieves continuation data as it is.

Returns

Promise<undefined | IBrowseResponse>

Inherited from

Feed.getContinuationData

Defined in

src/core/mixins/Feed.ts:201

---

getShelf()

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

Finds shelf by title.

Parameters

• title: string

Returns

undefined | ReelShelf | RichShelf | Shelf

Inherited from

Feed.getShelf

Defined in

src/core/mixins/Feed.ts:161

---

selectCategoryTab()

selectCategoryTab(tab): Promise<HomeFeed>

Retrieves the contents of the given category tab. Use HomeFeed.categories to get a list of available categories.

Parameters

• tab: string | KidsCategoryTab

The tab to select

Returns

Promise<HomeFeed>

Defined in

src/parser/ytkids/HomeFeed.ts:25

---

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

Feed.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

Feed.getVideosFromMemo

Defined in

src/core/mixins/Feed.ts:77