From 27a50a2a7e959ff0c2af6b2027b8f50036e660cf Mon Sep 17 00:00:00 2001
From: LuanRT <luan.lrt4@gmail.com>
Date: Thu, 16 Feb 2023 18:38:10 -0300
Subject: [PATCH] docs: add documentation for `Feed`, `FilterableFeed` and
 `TabbedFeed`

---
 README.md                   |  71 ++++++++++++++--------
 docs/API/feed.md            | 115 ++++++++++++++++++++++++++++++++++++
 docs/API/filterable-feed.md |  38 ++++++++++++
 docs/API/tabbed-feed.md     |  62 +++++++++++++++++++
 4 files changed, 260 insertions(+), 26 deletions(-)
 create mode 100644 docs/API/feed.md
 create mode 100644 docs/API/filterable-feed.md
 create mode 100644 docs/API/tabbed-feed.md

diff --git a/README.md b/README.md
index 53ed01cc..180e71aa 100644
--- a/README.md
+++ b/README.md
@@ -267,7 +267,7 @@ const yt = await Innertube.create({
 
 Retrieves video info, including playback data and even layout elements such as menus, buttons, etc — all nicely parsed.
 
-**Returns**: `Promise.<VideoInfo>`
+**Returns**: `Promise<VideoInfo>`
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -284,7 +284,7 @@ Retrieves video info, including playback data and even layout elements such as m
 - `<info>#dislike()`
   - Dislikes the video.
 
-- `<info>#removeLike()`
+- `<info>#removeRating()`
   - Removes like/dislike.
 
 - `<info>#getLiveChat()`
@@ -322,7 +322,7 @@ Retrieves video info, including playback data and even layout elements such as m
 
 Suitable for cases where you only need basic video metadata. Also, it is faster than [`getInfo()`](#getinfo).
 
-**Returns**: `Promise.<VideoInfo>`
+**Returns**: `Promise<VideoInfo>`
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -334,7 +334,10 @@ Suitable for cases where you only need basic video metadata. Also, it is faster
 
 Searches the given query on YouTube.
 
-**Returns**: `Promise.<Search>`
+**Returns**: `Promise<Search>`
+
+> **Note**
+> `Search` extends the [`Feed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/feed.md) class.
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -361,7 +364,7 @@ Searches the given query on YouTube.
 ### getSearchSuggestions(query)
 Retrieves search suggestions for given query.
 
-**Returns**: `Promise.<string[]>`
+**Returns**: `Promise<string[]>`
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -371,7 +374,7 @@ Retrieves search suggestions for given query.
 ### getComments(video_id, sort_by?)
 Retrieves comments for given video.
 
-**Returns**: `Promise.<Comments>`
+**Returns**: `Promise<Comments>`
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -384,7 +387,10 @@ See [`./examples/comments`](https://github.com/LuanRT/YouTube.js/blob/main/examp
 ### getHomeFeed()
 Retrieves YouTube's home feed.
 
-**Returns**: `Promise.<HomeFeed>`
+**Returns**: `Promise<HomeFeed>`
+
+> **Note**
+> `HomeFeed` extends the [`FilterableFeed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/filterable-feed.md) class.
 
 <details>
 <summary>Methods & Getters</summary>
@@ -415,7 +421,10 @@ Retrieves YouTube's home feed.
 ### getLibrary()
 Retrieves the account's library.
 
-**Returns**: `Promise.<Library>`
+**Returns**: `Promise<Library>`
+
+> **Note**
+> `Library` extends the [`Feed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/feed.md) class.
 
 <details>
 <summary>Methods & Getters</summary>
@@ -424,10 +433,8 @@ Retrieves the account's library.
 - `<library>#history`
 - `<library>#watch_later`
 - `<library>#liked_videos`
-- `<library>#playlists`
+- `<library>#playlists_section`
 - `<library>#clips`
-- `<library>#page`
-  - Returns original InnerTube response (sanitized).
 
 </p>
 </details> 
@@ -436,7 +443,10 @@ Retrieves the account's library.
 ### getHistory()
 Retrieves watch history.
 
-**Returns**: `Promise.<History>`
+**Returns**: `Promise<History>`
+
+> **Note**
+> `History` extends the [`Feed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/feed.md) class.
 
 <details>
 <summary>Methods & Getters</summary>
@@ -452,19 +462,22 @@ Retrieves watch history.
 ### getTrending()
 Retrieves trending content.
 
-**Returns**: `Promise.<TabbedFeed<IBrowseResponse>>`
+**Returns**: `Promise<TabbedFeed<IBrowseResponse>>`
 
 <a name="getsubscriptionsfeed"></a>
 ### getSubscriptionsFeed()
-Retrieves subscriptions feed.
+Retrieves the subscriptions feed.
 
-**Returns**: `Promise.<Feed<IBrowseResponse>>`
+**Returns**: `Promise<Feed<IBrowseResponse>>`
 
 <a name="getchannel"></a>
 ### getChannel(id)
 Retrieves contents for a given channel.
 
-**Returns**: `Promise.<Channel>`
+**Returns**: `Promise<Channel>`
+
+> **Note**
+> `Channel` extends the [`TabbedFeed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/tabbed-feed.md) class.
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -501,7 +514,7 @@ See [`./examples/channel`](https://github.com/LuanRT/YouTube.js/blob/main/exampl
 ### getNotifications()
 Retrieves notifications.
 
-**Returns**: `Promise.<NotificationsMenu>`
+**Returns**: `Promise<NotificationsMenu>`
 
 <details>
 <summary>Methods & Getter</summary>
@@ -517,13 +530,16 @@ Retrieves notifications.
 ### getUnseenNotificationsCount()
 Retrieves unseen notifications count.
 
-**Returns**: `Promise.<number>`
+**Returns**: `Promise<number>`
 
 <a name="getplaylist"></a>
 ### getPlaylist(id)
 Retrieves playlist contents.
 
-**Returns**: `Promise.<Playlist>`
+**Returns**: `Promise<Playlist>`
+
+> **Note**
+> `Playlist` extends the [`Feed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/feed.md) class.
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -543,7 +559,10 @@ Retrieves playlist contents.
 ### getHashtag(hashtag)
 Retrieves a given hashtag's page.
 
-**Returns**: `Promise.<HashtagFeed>`
+**Returns**: `Promise<HashtagFeed>`
+
+> **Note**
+> `HashtagFeed` extends the [`FilterableFeed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/filterable-feed.md) class.
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -565,15 +584,15 @@ Retrieves a given hashtag's page.
 ### getStreamingData(video_id, options)
 Returns deciphered streaming data.
 
-**Note:**
-It is recommended to retrieve streaming data from a `VideoInfo`/`TrackInfo` object instead if you want to select formats manually, example:
+**Note**
+This will be deprecated in the future. It is recommended to retrieve streaming data from a `VideoInfo`/`TrackInfo` object instead if you want to select formats manually, example:
 ```ts
 const info = await yt.getBasicInfo('somevideoid');
 const url = info.streaming_data?.formats[0].decipher(yt.session.player);
 console.info('Playback url:', url);
 ```
 
-**Returns**: `Promise.<object>`
+**Returns**: `Promise<object>`
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -584,7 +603,7 @@ console.info('Playback url:', url);
 ### download(video_id, options?)
 Downloads a given video.
 
-**Returns**: `Promise.<ReadableStream<Uint8Array>>`
+**Returns**: `Promise<ReadableStream<Uint8Array>>`
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -597,7 +616,7 @@ See [`./examples/download`](https://github.com/LuanRT/YouTube.js/blob/main/examp
 ### resolveURL(url)
 Resolves a given url.
 
-**Returns**: `Promise.<NavigationEndpoint>`
+**Returns**: `Promise<NavigationEndpoint>`
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -607,7 +626,7 @@ Resolves a given url.
 ### call(endpoint, args?)
 Utility to call navigation endpoints.
 
-**Returns**: `Promise.<T extends IParsedResponse | IParsedResponse | ApiResponse>`
+**Returns**: `Promise<T extends IParsedResponse | IParsedResponse | ApiResponse>`
 
 | Param | Type | Description |
 | --- | --- | --- |
diff --git a/docs/API/feed.md b/docs/API/feed.md
new file mode 100644
index 00000000..13c7e4b3
--- /dev/null
+++ b/docs/API/feed.md
@@ -0,0 +1,115 @@
+# Feed
+
+Represents a YouTube feed. This class provides a set of utility methods for parsing and interacting with feeds.
+
+## API 
+
+* Feed
+  * [.videos](#videos)
+  * [.posts](#posts)
+  * [.channels](#channels)
+  * [.playlists](#playlists)
+  * [.shelves](#shelves)
+  * [.memo](#memo)
+  * [.page_contents](#page_contents)
+  * [.secondary_contents](#secondary_contents)
+  * [.page](#page)
+  * [.has_continuation](#has_continuation)
+  * [.getContinuationData()](#getcontinuationdata)
+  * [.getContinuation()](#getcontinuation)
+  * [.getShelf(title)](#getshelf)
+
+<a name="videos"></a>
+### videos
+
+Returns all videos in the feed.
+
+**Returns:** `ObservedArray<Video | GridVideo | ReelItem | CompactVideo | PlaylistVideo | PlaylistPanelVideo | WatchCardCompactVideo>`
+
+<a name="posts"></a>
+### posts
+
+Returns all posts in the feed.
+
+**Returns:** `ObservedArray<Post | BackstagePost>`
+
+<a name="channels"></a>
+### channels
+
+Returns all channels in the feed.
+
+**Returns:** `ObservedArray<Channel | GridChannel>`
+
+<a name="playlists"></a>
+### playlists
+
+Returns all playlists in the feed.
+
+**Returns:** `ObservedArray<Playlist | GridPlaylist>`
+
+<a name="shelves"></a>
+### shelves
+
+Returns all shelves in the feed.
+
+**Returns:** `ObservedArray<Shelf | RichShelf | ReelShelf>`
+
+<a name="memo"></a>
+### memo
+
+Returns the memoized feed contents.
+
+**Returns:** `Memo`
+
+<a name="page_contents"></a>
+### page_contents
+
+Returns the page contents.
+
+**Returns:** `SectionList | MusicQueue | RichGrid | ReloadContinuationItemsCommand`
+
+<a name="secondary_contents"></a>
+### secondary_contents
+
+Returns the secondary contents node.
+
+**Returns:** `SuperParsedResult<YTNode> | undefined `
+
+<a name="page"></a>
+### page
+
+Returns the original InnerTube response, parsed and sanitized.
+
+**Returns:** `T extends IParsedResponse = IParsedResponse`
+
+<a name="has_continuation"></a>
+### has_continuation
+
+Returns whether the feed has a continuation.
+
+**Returns:** `boolean`
+
+<a name="getcontinuationdata"></a>
+### getContinuationData()
+
+Returns the continuation data.
+
+**Returns:** `Promise<T | undefined>`
+
+<a name="getcontinuation"></a>
+### getContinuation()
+
+Retrieves the feed's continuation.
+
+**Returns:** `Promise<Feed<T>>`
+
+<a name="getshelf"></a>
+### getShelf(title)
+
+Gets a shelf by its title.
+
+**Returns:** `Shelf | RichShelf | ReelShelf | undefined`
+
+| Param | Type | Description |
+| --- | --- | --- |
+| title | `string` | The title of the shelf to get |
\ No newline at end of file
diff --git a/docs/API/filterable-feed.md b/docs/API/filterable-feed.md
new file mode 100644
index 00000000..c45b1f0c
--- /dev/null
+++ b/docs/API/filterable-feed.md
@@ -0,0 +1,38 @@
+# FilterableFeed
+
+Represents a feed that can be filtered. 
+
+> **Note** 
+> This class extends the [Feed](feed.md) class.
+
+## API
+
+* FilterableFeed
+  * [.filter_chips](#filter_chips)
+  * [.filters](#filters)
+  * [.getFilteredFeed(filter: string | ChipCloudChip)](#getfilteredfeed)
+
+<a name="filter_chips"></a>
+### filter_chips
+
+Returns the feed's filter chips.
+
+**Returns:** `ObservedArray<ChipCloudChip>`
+
+<a name="filters"></a>
+### filters
+
+Returns the feed's filter chips as an array of strings.
+
+**Returns:** `string[]`
+
+<a name="getfilteredfeed"></a>
+### getFilteredFeed(filter: string | ChipCloudChip)
+
+Returns a new [Feed](feed.md) with the given filter applied.
+
+**Returns:** `Promise<Feed<T>>`
+
+| Param | Type | Description |
+| --- | --- | --- |
+| filter | `string` \| `ChipCloudChip` | The filter to apply |
\ No newline at end of file
diff --git a/docs/API/tabbed-feed.md b/docs/API/tabbed-feed.md
new file mode 100644
index 00000000..152e6cf1
--- /dev/null
+++ b/docs/API/tabbed-feed.md
@@ -0,0 +1,62 @@
+# TabbedFeed
+
+Represents a feed with tabs. 
+
+> **Note**
+> This class extends the [Feed](feed.md) class.
+
+## API
+
+* TabbedFeed
+  * [.tabs](#tabs)
+  * [.getTabByName(title: string)](#gettabbyname)
+  * [.getTabByURL(url: string)](#gettabbyurl)
+  * [.hasTabWithURL(url: string)](#hastabwithurl)
+  * [.title](#title)
+
+<a name="tabs"></a>
+### tabs
+
+Returns the feed's tabs as an array of strings.
+
+**Returns:** `string[]`
+
+<a name="gettabbyname"></a>
+### getTabByName(title: string)
+
+Fetches a tab by its title.
+
+**Returns:** `Promise<TabbedFeed<T>>`
+
+| Param | Type | Description |
+| --- | --- | --- |
+| title | `string` | The title of the tab to get |
+
+<a name="gettabbyurl"></a>
+### getTabByURL(url: string)
+
+Fetches a tab by its URL.
+
+**Returns:** `Promise<TabbedFeed<T>>`
+
+| Param | Type | Description |
+| --- | --- | --- |
+| url | `string` | The URL of the tab to get |
+
+<a name="hastabwithurl"></a>
+### hasTabWithURL(url: string)
+
+Returns whether the feed has a tab with the given URL.
+
+**Returns:** `boolean`
+
+| Param | Type | Description |
+| --- | --- | --- |
+| url | `string` | The URL to check |
+
+<a name="title"></a>
+### title
+
+Returns the currently selected tab's title.
+
+**Returns:** `string | undefined`
\ No newline at end of file