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

chore: add proper documentation (#763)

Browse Source 
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
This commit is contained in:
Luan
2024-09-23 17:32:50 -03:00
committed by GitHub
parent dd7f5cf778
commit 74659fd03f
853 changed files with 139814 additions and 1929 deletions
Download Patch File Download Diff File Expand all files Collapse all files

195
docs/api/namespaces/Constants/variables/CLIENTS.md Normal file
View File

@@ -0,0 +1,195 @@
[youtubei.js](../../../README.md) / [Constants](../README.md) / CLIENTS
# Variable: CLIENTS
> `const` **CLIENTS**: `Readonly`\<`object`\>
## Type declaration
### ANDROID
> **ANDROID**: `object`
### ANDROID.NAME
> **NAME**: `string` = `'ANDROID'`
### ANDROID.NAME\_ID
> **NAME\_ID**: `string` = `'3'`
### ANDROID.SDK\_VERSION
> **SDK\_VERSION**: `number` = `33`
### ANDROID.USER\_AGENT
> **USER\_AGENT**: `string` = `'com.google.android.youtube/18.48.37(Linux; U; Android 13; en_US; sdk_gphone64_x86_64 Build/UPB4.230623.005) gzip'`
### ANDROID.VERSION
> **VERSION**: `string` = `'18.48.37'`
### IOS
> **IOS**: `object`
### IOS.DEVICE\_MODEL
> **DEVICE\_MODEL**: `string` = `'iPhone10,6'`
### IOS.NAME
> **NAME**: `string` = `'iOS'`
### IOS.NAME\_ID
> **NAME\_ID**: `string` = `'5'`
### IOS.USER\_AGENT
> **USER\_AGENT**: `string` = `'com.google.ios.youtube/18.06.35 (iPhone; CPU iPhone OS 14_4 like Mac OS X; en_US)'`
### IOS.VERSION
> **VERSION**: `string` = `'18.06.35'`
### TV\_EMBEDDED
> **TV\_EMBEDDED**: `object`
### TV\_EMBEDDED.NAME
> **NAME**: `string` = `'TVHTML5_SIMPLY_EMBEDDED_PLAYER'`
### TV\_EMBEDDED.NAME\_ID
> **NAME\_ID**: `string` = `'85'`
### TV\_EMBEDDED.VERSION
> **VERSION**: `string` = `'2.0'`
### WEB
> **WEB**: `object`
### WEB.API\_KEY
> **API\_KEY**: `string` = `'AIzaSyAO_FJ2SlqU8Q4STEHLGCilw_Y9_11qcW8'`
### WEB.API\_VERSION
> **API\_VERSION**: `string` = `'v1'`
### WEB.NAME
> **NAME**: `string` = `'WEB'`
### WEB.NAME\_ID
> **NAME\_ID**: `string` = `'1'`
### WEB.STATIC\_VISITOR\_ID
> **STATIC\_VISITOR\_ID**: `string` = `'6zpwvWUNAco'`
### WEB.VERSION
> **VERSION**: `string` = `'2.20240111.09.00'`
### WEB\_EMBEDDED
> **WEB\_EMBEDDED**: `object`
### WEB\_EMBEDDED.API\_KEY
> **API\_KEY**: `string` = `'AIzaSyAO_FJ2SlqU8Q4STEHLGCilw_Y9_11qcW8'`
### WEB\_EMBEDDED.API\_VERSION
> **API\_VERSION**: `string` = `'v1'`
### WEB\_EMBEDDED.NAME
> **NAME**: `string` = `'WEB_EMBEDDED_PLAYER'`
### WEB\_EMBEDDED.NAME\_ID
> **NAME\_ID**: `string` = `'56'`
### WEB\_EMBEDDED.STATIC\_VISITOR\_ID
> **STATIC\_VISITOR\_ID**: `string` = `'6zpwvWUNAco'`
### WEB\_EMBEDDED.VERSION
> **VERSION**: `string` = `'2.20240111.09.00'`
### WEB\_KIDS
> **WEB\_KIDS**: `object`
### WEB\_KIDS.NAME
> **NAME**: `string` = `'WEB_KIDS'`
### WEB\_KIDS.NAME\_ID
> **NAME\_ID**: `string` = `'76'`
### WEB\_KIDS.VERSION
> **VERSION**: `string` = `'2.20230111.00.00'`
### YTMUSIC
> **YTMUSIC**: `object`
### YTMUSIC.NAME
> **NAME**: `string` = `'WEB_REMIX'`
### YTMUSIC.NAME\_ID
> **NAME\_ID**: `string` = `'67'`
### YTMUSIC.VERSION
> **VERSION**: `string` = `'1.20211213.00.00'`
### YTMUSIC\_ANDROID
> **YTMUSIC\_ANDROID**: `object`
### YTMUSIC\_ANDROID.NAME
> **NAME**: `string` = `'ANDROID_MUSIC'`
### YTMUSIC\_ANDROID.NAME\_ID
> **NAME\_ID**: `string` = `'21'`
### YTMUSIC\_ANDROID.VERSION
> **VERSION**: `string` = `'5.34.51'`
### YTSTUDIO\_ANDROID
> **YTSTUDIO\_ANDROID**: `object`
### YTSTUDIO\_ANDROID.NAME
> **NAME**: `string` = `'ANDROID_CREATOR'`
### YTSTUDIO\_ANDROID.NAME\_ID
> **NAME\_ID**: `string` = `'14'`
### YTSTUDIO\_ANDROID.VERSION
> **VERSION**: `string` = `'22.43.101'`
## Defined in
[src/utils/Constants.ts:25](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Constants.ts#L25)

23
docs/api/namespaces/Constants/variables/INNERTUBE_HEADERS_BASE.md Normal file
View File

@@ -0,0 +1,23 @@
[youtubei.js](../../../README.md) / [Constants](../README.md) / INNERTUBE\_HEADERS\_BASE
# Variable: INNERTUBE\_HEADERS\_BASE
> `const` **INNERTUBE\_HEADERS\_BASE**: `Readonly`\<`object`\>
## Type declaration
### accept
> **accept**: `"*/*"` = `'*/*'`
### accept-encoding
> **accept-encoding**: `"gzip, deflate"` = `'gzip, deflate'`
### content-type
> **content-type**: `"application/json"` = `'application/json'`
## Defined in
[src/utils/Constants.ts:88](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Constants.ts#L88)

25
docs/api/namespaces/Constants/variables/OAUTH.md Normal file
View File

@@ -0,0 +1,25 @@
[youtubei.js](../../../README.md) / [Constants](../README.md) / OAUTH
# Variable: OAUTH
> `const` **OAUTH**: `Readonly`\<`object`\>
## Type declaration
### REGEX
> **REGEX**: `Readonly`\<`object`\>
#### Type declaration
##### CLIENT\_IDENTITY
> **CLIENT\_IDENTITY**: `RegExp`
##### TV\_SCRIPT
> **TV\_SCRIPT**: `RegExp`
## Defined in
[src/utils/Constants.ts:19](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Constants.ts#L19)

27
docs/api/namespaces/Constants/variables/STREAM_HEADERS.md Normal file
View File

@@ -0,0 +1,27 @@
[youtubei.js](../../../README.md) / [Constants](../README.md) / STREAM\_HEADERS
# Variable: STREAM\_HEADERS
> `const` **STREAM\_HEADERS**: `Readonly`\<`object`\>
## Type declaration
### accept
> **accept**: `"*/*"` = `'*/*'`
### DNT
> **DNT**: `"?1"` = `'?1'`
### origin
> **origin**: `"https://www.youtube.com"` = `'https://www.youtube.com'`
### referer
> **referer**: `"https://www.youtube.com"` = `'https://www.youtube.com'`
## Defined in
[src/utils/Constants.ts:82](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Constants.ts#L82)

9
docs/api/namespaces/Constants/variables/SUPPORTED_CLIENTS.md Normal file
View File

@@ -0,0 +1,9 @@
[youtubei.js](../../../README.md) / [Constants](../README.md) / SUPPORTED\_CLIENTS
# Variable: SUPPORTED\_CLIENTS
> `const` **SUPPORTED\_CLIENTS**: `string`[]
## Defined in
[src/utils/Constants.ts:94](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Constants.ts#L94)

69
docs/api/namespaces/Constants/variables/URLS.md Normal file
View File

@@ -0,0 +1,69 @@
[youtubei.js](../../../README.md) / [Constants](../README.md) / URLS
# Variable: URLS
> `const` **URLS**: `Readonly`\<`object`\>
## Type declaration
### API
> **API**: `Readonly`\<`object`\>
#### Type declaration
##### BASE
> **BASE**: `"https://youtubei.googleapis.com"` = `'https://youtubei.googleapis.com'`
##### CAMI
> **CAMI**: `"http://cami-youtubei.sandbox.googleapis.com/youtubei/"` = `'http://cami-youtubei.sandbox.googleapis.com/youtubei/'`
##### PRODUCTION\_1
> **PRODUCTION\_1**: `"https://www.youtube.com/youtubei/"` = `'https://www.youtube.com/youtubei/'`
##### PRODUCTION\_2
> **PRODUCTION\_2**: `"https://youtubei.googleapis.com/youtubei/"` = `'https://youtubei.googleapis.com/youtubei/'`
##### RELEASE
> **RELEASE**: `"https://release-youtubei.sandbox.googleapis.com/youtubei/"` = `'https://release-youtubei.sandbox.googleapis.com/youtubei/'`
##### STAGING
> **STAGING**: `"https://green-youtubei.sandbox.googleapis.com/youtubei/"` = `'https://green-youtubei.sandbox.googleapis.com/youtubei/'`
##### TEST
> **TEST**: `"https://test-youtubei.sandbox.googleapis.com/youtubei/"` = `'https://test-youtubei.sandbox.googleapis.com/youtubei/'`
##### UYTFE
> **UYTFE**: `"https://uytfe.sandbox.google.com/youtubei/"` = `'https://uytfe.sandbox.google.com/youtubei/'`
### GOOGLE\_SEARCH\_BASE
> **GOOGLE\_SEARCH\_BASE**: `"https://www.google.com/"` = `'https://www.google.com/'`
### YT\_BASE
> **YT\_BASE**: `"https://www.youtube.com"` = `'https://www.youtube.com'`
### YT\_MUSIC\_BASE
> **YT\_MUSIC\_BASE**: `"https://music.youtube.com"` = `'https://music.youtube.com'`
### YT\_SUGGESTIONS
> **YT\_SUGGESTIONS**: `"https://suggestqueries.google.com/complete/"` = `'https://suggestqueries.google.com/complete/'`
### YT\_UPLOAD
> **YT\_UPLOAD**: `"https://upload.youtube.com/"` = `'https://upload.youtube.com/'`
## Defined in
[src/utils/Constants.ts:2](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Constants.ts#L2)