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

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

View File

@@ -30,7 +30,7 @@
#### Defined in
[src/parser/youtube/Channel.ts:296](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/Channel.ts#L296)
[src/parser/youtube/Channel.ts:296](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/Channel.ts#L296)
## Properties
@@ -40,7 +40,7 @@
#### Defined in
[src/parser/youtube/Channel.ts:294](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/Channel.ts#L294)
[src/parser/youtube/Channel.ts:294](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/Channel.ts#L294)
## Accessors
@@ -58,7 +58,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)
***
@@ -78,7 +78,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)
***
@@ -98,7 +98,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)
***
@@ -116,7 +116,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)
***
@@ -136,7 +136,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)
***
@@ -156,7 +156,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)
***
@@ -176,7 +176,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)
***
@@ -196,7 +196,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)
***
@@ -216,7 +216,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)
***
@@ -236,7 +236,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)
***
@@ -256,7 +256,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
@@ -276,7 +276,7 @@ Retrieves next batch of contents and returns a new [Feed](../../Mixins/classes/F
#### Defined in
[src/parser/youtube/Channel.ts:303](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/youtube/Channel.ts#L303)
[src/parser/youtube/Channel.ts:303](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/youtube/Channel.ts#L303)
***
@@ -296,7 +296,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)
***
@@ -320,7 +320,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)
***
@@ -344,7 +344,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)
***
@@ -368,4 +368,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)