Files
YouTube.js/docs/api/namespaces/Mixins/classes/Feed.md
Luan 74659fd03f chore: add proper documentation (#763)
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
2024-09-23 17:32:50 -03:00

11 KiB

youtubei.js / Mixins / Feed

Class: Feed<T>

Extended by

Type Parameters

T extends IParsedResponse = IParsedResponse

Constructors

new Feed()

new Feed<T>(actions, response, already_parsed): Feed<T>

Parameters

actions: Actions

response: IParsedResponse | ApiResponse

already_parsed: boolean = false

Returns

Feed<T>

Defined in

src/core/mixins/Feed.ts:46

Accessors

actions

get actions(): Actions

Returns

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>

Defined in

src/core/mixins/Feed.ts:125


has_continuation

get has_continuation(): boolean

Checks if the feed has continuation.

Returns

boolean

Defined in

src/core/mixins/Feed.ts:194


memo

get memo(): Memo

Returns

Memo

Defined in

src/core/mixins/Feed.ts:136


page

get page(): T

Get the original page data

Returns

T

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

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>

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>

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>

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>

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>

Defined in

src/core/mixins/Feed.ts:111

Methods

getContinuation()

getContinuation(): Promise<Feed<T>>

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

Returns

Promise<Feed<T>>

Defined in

src/core/mixins/Feed.ts:220


getContinuationData()

getContinuationData(): Promise<undefined | T>

Retrieves continuation data as it is.

Returns

Promise<undefined | T>

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

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>

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>

Defined in

src/core/mixins/Feed.ts:77