jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-25 15:52:13 +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

70
docs/api/classes/Innertube.md
View File

@@ -27,7 +27,7 @@ const innertube = await Innertube.create({ cache: new UniversalCache(true)});
#### Defined in
[src/Innertube.ts:55](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L55)
[src/Innertube.ts:55](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L55)
## Accessors
@@ -43,7 +43,7 @@ An interface for managing and retrieving account information.
#### Defined in
[src/Innertube.ts:466](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L466)
[src/Innertube.ts:466](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L466)
***
@@ -59,7 +59,7 @@ An internal class used to dispatch requests.
#### Defined in
[src/Innertube.ts:487](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L487)
[src/Innertube.ts:487](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L487)
***
@@ -75,7 +75,7 @@ An interface for directly interacting with certain YouTube features.
#### Defined in
[src/Innertube.ts:480](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L480)
[src/Innertube.ts:480](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L480)
***
@@ -91,7 +91,7 @@ An interface for interacting with YouTube Kids.
#### Defined in
[src/Innertube.ts:459](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L459)
[src/Innertube.ts:459](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L459)
***
@@ -107,7 +107,7 @@ An interface for interacting with YouTube Music.
#### Defined in
[src/Innertube.ts:445](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L445)
[src/Innertube.ts:445](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L445)
***
@@ -123,7 +123,7 @@ An interface for managing playlists.
#### Defined in
[src/Innertube.ts:473](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L473)
[src/Innertube.ts:473](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L473)
***
@@ -139,7 +139,7 @@ The session used by this instance.
#### Defined in
[src/Innertube.ts:494](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L494)
[src/Innertube.ts:494](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L494)
***
@@ -155,7 +155,7 @@ An interface for interacting with YouTube Studio.
#### Defined in
[src/Innertube.ts:452](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L452)
[src/Innertube.ts:452](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L452)
## Methods
@@ -185,7 +185,7 @@ Utility method to call an endpoint without having to use [Actions](Actions.md).
##### Defined in
[src/Innertube.ts:436](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L436)
[src/Innertube.ts:436](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L436)
#### call(endpoint, args)
@@ -205,7 +205,7 @@ Utility method to call an endpoint without having to use [Actions](Actions.md).
##### Defined in
[src/Innertube.ts:437](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L437)
[src/Innertube.ts:437](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L437)
***
@@ -232,7 +232,7 @@ Download options.
#### Defined in
[src/Innertube.ts:416](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L416)
[src/Innertube.ts:416](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L416)
***
@@ -252,7 +252,7 @@ Download options.
#### Defined in
[src/Innertube.ts:102](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L102)
[src/Innertube.ts:102](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L102)
***
@@ -270,7 +270,7 @@ Download options.
#### Defined in
[src/Innertube.ts:335](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L335)
[src/Innertube.ts:335](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L335)
***
@@ -284,7 +284,7 @@ Download options.
#### Defined in
[src/Innertube.ts:329](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L329)
[src/Innertube.ts:329](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L329)
***
@@ -306,7 +306,7 @@ Download options.
#### Defined in
[src/Innertube.ts:250](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L250)
[src/Innertube.ts:250](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L250)
***
@@ -320,7 +320,7 @@ Download options.
#### Defined in
[src/Innertube.ts:317](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L317)
[src/Innertube.ts:317](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L317)
***
@@ -334,7 +334,7 @@ Download options.
#### Defined in
[src/Innertube.ts:294](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L294)
[src/Innertube.ts:294](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L294)
***
@@ -352,7 +352,7 @@ Download options.
#### Defined in
[src/Innertube.ts:375](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L375)
[src/Innertube.ts:375](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L375)
***
@@ -366,7 +366,7 @@ Download options.
#### Defined in
[src/Innertube.ts:305](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L305)
[src/Innertube.ts:305](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L305)
***
@@ -380,7 +380,7 @@ Download options.
#### Defined in
[src/Innertube.ts:288](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L288)
[src/Innertube.ts:288](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L288)
***
@@ -400,7 +400,7 @@ Download options.
#### Defined in
[src/Innertube.ts:63](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L63)
[src/Innertube.ts:63](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L63)
***
@@ -414,7 +414,7 @@ Download options.
#### Defined in
[src/Innertube.ts:299](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L299)
[src/Innertube.ts:299](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L299)
***
@@ -428,7 +428,7 @@ Download options.
#### Defined in
[src/Innertube.ts:342](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L342)
[src/Innertube.ts:342](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L342)
***
@@ -446,7 +446,7 @@ Download options.
#### Defined in
[src/Innertube.ts:362](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L362)
[src/Innertube.ts:362](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L362)
***
@@ -462,7 +462,7 @@ Retrieves the user's playlists.
#### Defined in
[src/Innertube.ts:356](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L356)
[src/Innertube.ts:356](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L356)
***
@@ -480,7 +480,7 @@ Retrieves the user's playlists.
#### Defined in
[src/Innertube.ts:231](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L231)
[src/Innertube.ts:231](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L231)
***
@@ -500,7 +500,7 @@ Retrieves the user's playlists.
#### Defined in
[src/Innertube.ts:127](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L127)
[src/Innertube.ts:127](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L127)
***
@@ -529,7 +529,7 @@ Format options.
#### Defined in
[src/Innertube.ts:401](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L401)
[src/Innertube.ts:401](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L401)
***
@@ -543,7 +543,7 @@ Format options.
#### Defined in
[src/Innertube.ts:323](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L323)
[src/Innertube.ts:323](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L323)
***
@@ -557,7 +557,7 @@ Format options.
#### Defined in
[src/Innertube.ts:311](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L311)
[src/Innertube.ts:311](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L311)
***
@@ -571,7 +571,7 @@ Format options.
#### Defined in
[src/Innertube.ts:347](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L347)
[src/Innertube.ts:347](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L347)
***
@@ -591,7 +591,7 @@ Resolves the given URL.
#### Defined in
[src/Innertube.ts:424](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L424)
[src/Innertube.ts:424](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L424)
***
@@ -611,7 +611,7 @@ Resolves the given URL.
#### Defined in
[src/Innertube.ts:160](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L160)
[src/Innertube.ts:160](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L160)
***
@@ -629,4 +629,4 @@ Resolves the given URL.
#### Defined in
[src/Innertube.ts:59](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/Innertube.ts#L59)
[src/Innertube.ts:59](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/Innertube.ts#L59)