youtubei.js / YT / HomeFeed

Class: HomeFeed

Extends

• FilterableFeed<IBrowseResponse>

Constructors

new HomeFeed()

new HomeFeed(actions, data, already_parsed): HomeFeed

Parameters

• actions: Actions

• data: ApiResponse | IBrowseResponse

• already_parsed: boolean = false

Returns

HomeFeed

Overrides

FilterableFeed.constructor

Defined in

src/parser/youtube/HomeFeed.ts:14

Properties

contents?

optional contents: ReloadContinuationItemsCommand | AppendContinuationItemsAction | RichGrid

Defined in

src/parser/youtube/HomeFeed.ts:11

---

header?

optional header: FeedTabbedHeader

Defined in

src/parser/youtube/HomeFeed.ts:12

Accessors

actions

get actions(): Actions

Returns

Actions

Inherited from

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

FilterableFeed.channels

Defined in

src/core/mixins/Feed.ts:125

---

filter_chips

get filter_chips(): ObservedArray<ChipCloudChip>

Returns the filter chips.

Returns

ObservedArray<ChipCloudChip>

Inherited from

FilterableFeed.filter_chips

Defined in

src/core/mixins/FilterableFeed.ts:20

---

filters

get filters(): string[]

Returns available filters.

Returns

string[]

Inherited from

FilterableFeed.filters

Defined in

src/core/mixins/FilterableFeed.ts:38

---

has_continuation

get has_continuation(): boolean

Checks if the feed has continuation.

Returns

boolean

Inherited from

FilterableFeed.has_continuation

Defined in

src/core/mixins/Feed.ts:194

---

memo

get memo(): Memo

Returns

Memo

Inherited from

FilterableFeed.memo

Defined in

src/core/mixins/Feed.ts:136

---

page

get page(): T

Get the original page data

Returns

T

Inherited from

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

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

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

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

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

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

FilterableFeed.videos

Defined in

src/core/mixins/Feed.ts:111

Methods

applyFilter()

applyFilter(filter): Promise<HomeFeed>

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

Parameters

• filter: string | ChipCloudChip

Filter to apply.

Returns

Promise<HomeFeed>

Defined in

src/parser/youtube/HomeFeed.ts:24

---

getContinuation()

getContinuation(): Promise<HomeFeed>

Retrieves next batch of contents.

Returns

Promise<HomeFeed>

Overrides

FilterableFeed.getContinuation

Defined in

src/parser/youtube/HomeFeed.ts:32

---

getContinuationData()

getContinuationData(): Promise<undefined | IBrowseResponse>

Retrieves continuation data as it is.

Returns

Promise<undefined | IBrowseResponse>

Inherited from

FilterableFeed.getContinuationData

Defined in

src/core/mixins/Feed.ts:201

---

getFilteredFeed()

getFilteredFeed(filter): Promise<Feed<IBrowseResponse>>

Applies given filter and returns a new Feed object.

Parameters

• filter: string | ChipCloudChip

Returns

Promise<Feed<IBrowseResponse>>

Inherited from

FilterableFeed.getFilteredFeed

Defined in

src/core/mixins/FilterableFeed.ts:45

---

getShelf()

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

Finds shelf by title.

Parameters

• title: string

Returns

undefined | ReelShelf | RichShelf | Shelf

Inherited from

FilterableFeed.getShelf

Defined in

src/core/mixins/Feed.ts:161

---

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

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

FilterableFeed.getVideosFromMemo

Defined in

src/core/mixins/Feed.ts:77