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

chore(docs): update

Browse Source
This commit is contained in:
LuanRT
2026-05-07 14:38:16 -03:00
parent faaf5fc5c1
commit 03cb4d6801
859 changed files with 11610 additions and 9101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/api/classes/OAuth2.md
View File

@@ -2,7 +2,7 @@
# Class: OAuth2
Defined in: [src/core/OAuth2.ts:35](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L35)
Defined in: [src/core/OAuth2.ts:35](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L35)
## Constructors
@@ -10,7 +10,7 @@ Defined in: [src/core/OAuth2.ts:35](https://github.com/LuanRT/YouTube.js/blob/07
> **new OAuth2**(`session`): `OAuth2`
Defined in: [src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L46)
Defined in: [src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L46)
#### Parameters
@@ -28,7 +28,7 @@ Defined in: [src/core/OAuth2.ts:46](https://github.com/LuanRT/YouTube.js/blob/07
> **AUTH\_SERVER\_CODE\_URL**: `URL`
Defined in: [src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L39)
Defined in: [src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L39)
***
@@ -36,7 +36,7 @@ Defined in: [src/core/OAuth2.ts:39](https://github.com/LuanRT/YouTube.js/blob/07
> **AUTH\_SERVER\_REVOKE\_TOKEN\_URL**: `URL`
Defined in: [src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L41)
Defined in: [src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L41)
***
@@ -44,7 +44,7 @@ Defined in: [src/core/OAuth2.ts:41](https://github.com/LuanRT/YouTube.js/blob/07
> **AUTH\_SERVER\_TOKEN\_URL**: `URL`
Defined in: [src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L40)
Defined in: [src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L40)
***
@@ -52,7 +52,7 @@ Defined in: [src/core/OAuth2.ts:40](https://github.com/LuanRT/YouTube.js/blob/07
> **client\_id**: [`OAuth2ClientID`](../type-aliases/OAuth2ClientID.md) \| `undefined`
Defined in: [src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L43)
Defined in: [src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L43)
***
@@ -60,7 +60,7 @@ Defined in: [src/core/OAuth2.ts:43](https://github.com/LuanRT/YouTube.js/blob/07
> **oauth2\_tokens**: [`OAuth2Tokens`](../type-aliases/OAuth2Tokens.md) \| `undefined`
Defined in: [src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L44)
Defined in: [src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L44)
***
@@ -68,7 +68,7 @@ Defined in: [src/core/OAuth2.ts:44](https://github.com/LuanRT/YouTube.js/blob/07
> **YTTV\_URL**: `URL`
Defined in: [src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L38)
Defined in: [src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L38)
## Methods
@@ -76,7 +76,7 @@ Defined in: [src/core/OAuth2.ts:38](https://github.com/LuanRT/YouTube.js/blob/07
> **cacheCredentials**(): `Promise`\<`void`\>
Defined in: [src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L105)
Defined in: [src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L105)
#### Returns
@@ -88,7 +88,7 @@ Defined in: [src/core/OAuth2.ts:105](https://github.com/LuanRT/YouTube.js/blob/0
> **getClientID**(): `Promise`\<[`OAuth2ClientID`](../type-aliases/OAuth2ClientID.md)\>
Defined in: [src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L268)
Defined in: [src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L268)
#### Returns
@@ -100,7 +100,7 @@ Defined in: [src/core/OAuth2.ts:268](https://github.com/LuanRT/YouTube.js/blob/0
> **getDeviceAndUserCode**(): `Promise`\<[`DeviceAndUserCode`](../type-aliases/DeviceAndUserCode.md)\>
Defined in: [src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L236)
Defined in: [src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L236)
#### Returns
@@ -112,7 +112,7 @@ Defined in: [src/core/OAuth2.ts:236](https://github.com/LuanRT/YouTube.js/blob/0
> **init**(`tokens?`): `Promise`\<`void`\>
Defined in: [src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L54)
Defined in: [src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L54)
#### Parameters
@@ -130,7 +130,7 @@ Defined in: [src/core/OAuth2.ts:54](https://github.com/LuanRT/YouTube.js/blob/07
> **pollForAccessToken**(`device_and_user_code`): `void`
Defined in: [src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L130)
Defined in: [src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L130)
#### Parameters
@@ -148,7 +148,7 @@ Defined in: [src/core/OAuth2.ts:130](https://github.com/LuanRT/YouTube.js/blob/0
> **refreshAccessToken**(): `Promise`\<`void`\>
Defined in: [src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L197)
Defined in: [src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L197)
#### Returns
@@ -160,7 +160,7 @@ Defined in: [src/core/OAuth2.ts:197](https://github.com/LuanRT/YouTube.js/blob/0
> **removeCache**(): `Promise`\<`void`\>
Defined in: [src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L126)
Defined in: [src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L126)
#### Returns
@@ -172,7 +172,7 @@ Defined in: [src/core/OAuth2.ts:126](https://github.com/LuanRT/YouTube.js/blob/0
> **revokeCredentials**(): `Promise`\<`Response` \| `undefined`\>
Defined in: [src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L185)
Defined in: [src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L185)
#### Returns
@@ -184,7 +184,7 @@ Defined in: [src/core/OAuth2.ts:185](https://github.com/LuanRT/YouTube.js/blob/0
> **setTokens**(`tokens`): `void`
Defined in: [src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L85)
Defined in: [src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L85)
#### Parameters
@@ -202,7 +202,7 @@ Defined in: [src/core/OAuth2.ts:85](https://github.com/LuanRT/YouTube.js/blob/07
> **shouldRefreshToken**(): `boolean`
Defined in: [src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L313)
Defined in: [src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L313)
#### Returns
@@ -214,7 +214,7 @@ Defined in: [src/core/OAuth2.ts:313](https://github.com/LuanRT/YouTube.js/blob/0
> **validateTokens**(`tokens`): `boolean`
Defined in: [src/core/OAuth2.ts:319](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/core/OAuth2.ts#L319)
Defined in: [src/core/OAuth2.ts:319](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/OAuth2.ts#L319)
#### Parameters