jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-28 09:06:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Update API ref [skip ci]

Browse Source
This commit is contained in:
Luan
2024-11-25 03:25:27 -03:00
parent 4729016fb9
commit fcd65b4dba
756 changed files with 7232 additions and 7009 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/api/namespaces/YT/classes/HomeFeed.md
View File

@@ -30,7 +30,7 @@
#### Defined in
[src/parser/youtube/HomeFeed.ts:14](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/HomeFeed.ts#L14)
[src/parser/youtube/HomeFeed.ts:14](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/HomeFeed.ts#L14)
## Properties
@@ -40,7 +40,7 @@
#### Defined in
[src/parser/youtube/HomeFeed.ts:11](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/HomeFeed.ts#L11)
[src/parser/youtube/HomeFeed.ts:11](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/HomeFeed.ts#L11)
***
@@ -50,7 +50,7 @@
#### Defined in
[src/parser/youtube/HomeFeed.ts:12](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/HomeFeed.ts#L12)
[src/parser/youtube/HomeFeed.ts:12](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/HomeFeed.ts#L12)
## Accessors
@@ -68,7 +68,7 @@
#### Defined in
[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L178)
[src/core/mixins/Feed.ts:178](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L178)
***
@@ -88,7 +88,7 @@ Get all the channels in the feed
#### Defined in
[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L123)
[src/core/mixins/Feed.ts:123](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L123)
***
@@ -108,7 +108,7 @@ Returns the filter chips.
#### Defined in
[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/FilterableFeed.ts#L20)
[src/core/mixins/FilterableFeed.ts:20](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/FilterableFeed.ts#L20)
***
@@ -128,7 +128,7 @@ Returns available filters.
#### Defined in
[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/FilterableFeed.ts#L38)
[src/core/mixins/FilterableFeed.ts:38](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/FilterableFeed.ts#L38)
***
@@ -148,7 +148,7 @@ Checks if the feed has continuation.
#### Defined in
[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L192)
[src/core/mixins/Feed.ts:192](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L192)
***
@@ -166,7 +166,7 @@ Checks if the feed has continuation.
#### Defined in
[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L134)
[src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L134)
***
@@ -186,7 +186,7 @@ Get the original page data
#### Defined in
[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L185)
[src/core/mixins/Feed.ts:185](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L185)
***
@@ -206,7 +206,7 @@ Returns contents from the page.
#### Defined in
[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L141)
[src/core/mixins/Feed.ts:141](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L141)
***
@@ -226,7 +226,7 @@ Get all playlists in the feed
#### Defined in
[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L130)
[src/core/mixins/Feed.ts:130](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L130)
***
@@ -246,7 +246,7 @@ Get all the community posts in the feed
#### Defined in
[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L116)
[src/core/mixins/Feed.ts:116](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L116)
***
@@ -266,7 +266,7 @@ Returns secondary contents from the page.
#### Defined in
[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L166)
[src/core/mixins/Feed.ts:166](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L166)
***
@@ -286,7 +286,7 @@ Returns all segments/sections from the page.
#### Defined in
[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L152)
[src/core/mixins/Feed.ts:152](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L152)
***
@@ -306,7 +306,7 @@ Get all the videos in the feed
#### Defined in
[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L109)
[src/core/mixins/Feed.ts:109](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L109)
## Methods
@@ -328,7 +328,7 @@ Filter to apply.
#### Defined in
[src/parser/youtube/HomeFeed.ts:24](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/HomeFeed.ts#L24)
[src/parser/youtube/HomeFeed.ts:24](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/HomeFeed.ts#L24)
***
@@ -348,7 +348,7 @@ Retrieves next batch of contents.
#### Defined in
[src/parser/youtube/HomeFeed.ts:32](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/HomeFeed.ts#L32)
[src/parser/youtube/HomeFeed.ts:32](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/HomeFeed.ts#L32)
***
@@ -368,7 +368,7 @@ Retrieves continuation data as it is.
#### Defined in
[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L199)
[src/core/mixins/Feed.ts:199](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L199)
***
@@ -392,7 +392,7 @@ Applies given filter and returns a new [Feed](../../Mixins/classes/Feed.md) obje
#### Defined in
[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/FilterableFeed.ts#L45)
[src/core/mixins/FilterableFeed.ts:45](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/FilterableFeed.ts#L45)
***
@@ -416,7 +416,7 @@ Finds shelf by title.
#### Defined in
[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L159)
[src/core/mixins/Feed.ts:159](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L159)
***
@@ -440,7 +440,7 @@ Get all playlists on a given page via memo
#### Defined in
[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L91)
[src/core/mixins/Feed.ts:91](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L91)
***
@@ -464,4 +464,4 @@ Get all videos on a given page via memo
#### Defined in
[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/core/mixins/Feed.ts#L75)
[src/core/mixins/Feed.ts:75](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/core/mixins/Feed.ts#L75)