mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-28 09:06:51 +00:00
chore: add proper documentation (#763)
* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
This commit is contained in:
Luan
306
docs/api/namespaces/Mixins/classes/Feed.md
Normal file
306
docs/api/namespaces/Mixins/classes/Feed.md
Normal file
@@ -0,0 +1,306 @@
|
||||
[youtubei.js](../../../README.md) / [Mixins](../README.md) / Feed
|
||||
|
||||
# Class: Feed\<T\>
|
||||
|
||||
## Extended by
|
||||
|
||||
- [`FilterableFeed`](FilterableFeed.md)
|
||||
- [`TabbedFeed`](TabbedFeed.md)
|
||||
- [`History`](../../YT/classes/History.md)
|
||||
- [`Library`](../../YT/classes/Library.md)
|
||||
- [`Playlist`](../../YT/classes/Playlist.md)
|
||||
- [`Search`](../../YT/classes/Search.md)
|
||||
- [`ChannelListContinuation`](../../YT/classes/ChannelListContinuation.md)
|
||||
- [`Channel`](../../YTKids/classes/Channel.md)
|
||||
- [`HomeFeed`](../../YTKids/classes/HomeFeed.md)
|
||||
- [`Search`](../../YTKids/classes/Search.md)
|
||||
|
||||
## Type Parameters
|
||||
|
||||
• **T** *extends* [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) = [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)
|
||||
|
||||
## Constructors
|
||||
|
||||
### new Feed()
|
||||
|
||||
> **new Feed**\<`T`\>(`actions`, `response`, `already_parsed`): [`Feed`](Feed.md)\<`T`\>
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **actions**: [`Actions`](../../../classes/Actions.md)
|
||||
|
||||
• **response**: [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) \| [`ApiResponse`](../../../interfaces/ApiResponse.md)
|
||||
|
||||
• **already\_parsed**: `boolean` = `false`
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Feed`](Feed.md)\<`T`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:46](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L46)
|
||||
|
||||
## Accessors
|
||||
|
||||
### actions
|
||||
|
||||
> `get` **actions**(): [`Actions`](../../../classes/Actions.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Actions`](../../../classes/Actions.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:180](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L180)
|
||||
|
||||
***
|
||||
|
||||
### channels
|
||||
|
||||
> `get` **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\>
|
||||
|
||||
Get all the channels in the feed
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:125](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L125)
|
||||
|
||||
***
|
||||
|
||||
### has\_continuation
|
||||
|
||||
> `get` **has\_continuation**(): `boolean`
|
||||
|
||||
Checks if the feed has continuation.
|
||||
|
||||
#### Returns
|
||||
|
||||
`boolean`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:194](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L194)
|
||||
|
||||
***
|
||||
|
||||
### memo
|
||||
|
||||
> `get` **memo**(): [`Memo`](../../Helpers/classes/Memo.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Memo`](../../Helpers/classes/Memo.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:136](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L136)
|
||||
|
||||
***
|
||||
|
||||
### page
|
||||
|
||||
> `get` **page**(): `T`
|
||||
|
||||
Get the original page data
|
||||
|
||||
#### Returns
|
||||
|
||||
`T`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:187](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L187)
|
||||
|
||||
***
|
||||
|
||||
### page\_contents
|
||||
|
||||
> `get` **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md)
|
||||
|
||||
Returns contents from the page.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`SectionList`](../../YTNodes/classes/SectionList.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:143](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L143)
|
||||
|
||||
***
|
||||
|
||||
### playlists
|
||||
|
||||
> `get` **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\>
|
||||
|
||||
Get all playlists in the feed
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:132](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L132)
|
||||
|
||||
***
|
||||
|
||||
### posts
|
||||
|
||||
> `get` **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\>
|
||||
|
||||
Get all the community posts in the feed
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md) \| [`Post`](../../YTNodes/classes/Post.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:118](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L118)
|
||||
|
||||
***
|
||||
|
||||
### secondary\_contents
|
||||
|
||||
> `get` **secondary\_contents**(): `undefined` \| [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
|
||||
|
||||
Returns secondary contents from the page.
|
||||
|
||||
#### Returns
|
||||
|
||||
`undefined` \| [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:168](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L168)
|
||||
|
||||
***
|
||||
|
||||
### shelves
|
||||
|
||||
> `get` **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\>
|
||||
|
||||
Returns all segments/sections from the page.
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:154](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L154)
|
||||
|
||||
***
|
||||
|
||||
### videos
|
||||
|
||||
> `get` **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Video`](../../YTNodes/classes/Video.md) \| [`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\>
|
||||
|
||||
Get all the videos in the feed
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Video`](../../YTNodes/classes/Video.md) \| [`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:111](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L111)
|
||||
|
||||
## Methods
|
||||
|
||||
### getContinuation()
|
||||
|
||||
> **getContinuation**(): `Promise`\<[`Feed`](Feed.md)\<`T`\>\>
|
||||
|
||||
Retrieves next batch of contents and returns a new [Feed](Feed.md) object.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<[`Feed`](Feed.md)\<`T`\>\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:220](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L220)
|
||||
|
||||
***
|
||||
|
||||
### getContinuationData()
|
||||
|
||||
> **getContinuationData**(): `Promise`\<`undefined` \| `T`\>
|
||||
|
||||
Retrieves continuation data as it is.
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<`undefined` \| `T`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:201](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L201)
|
||||
|
||||
***
|
||||
|
||||
### getShelf()
|
||||
|
||||
> **getShelf**(`title`): `undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)
|
||||
|
||||
Finds shelf by title.
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **title**: `string`
|
||||
|
||||
#### Returns
|
||||
|
||||
`undefined` \| [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:161](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L161)
|
||||
|
||||
***
|
||||
|
||||
### getPlaylistsFromMemo()
|
||||
|
||||
> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\>
|
||||
|
||||
Get all playlists on a given page via memo
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **memo**: [`Memo`](../../Helpers/classes/Memo.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:93](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L93)
|
||||
|
||||
***
|
||||
|
||||
### getVideosFromMemo()
|
||||
|
||||
> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Video`](../../YTNodes/classes/Video.md) \| [`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\>
|
||||
|
||||
Get all videos on a given page via memo
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **memo**: [`Memo`](../../Helpers/classes/Memo.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Video`](../../YTNodes/classes/Video.md) \| [`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/core/mixins/Feed.ts:77](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/Feed.ts#L77)
|
||||
Reference in New Issue
Block a user