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

chore(docs): Regen API ref

Browse Source
This commit is contained in:
LuanRT
2026-05-12 23:01:15 -03:00
parent 853a36307b
commit 0a82c8bd99
857 changed files with 8999 additions and 8813 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/youtubei.js/namespaces/Managers/classes/AccountManager.md
View File

@@ -2,7 +2,7 @@
# Class: AccountManager
Defined in: [src/core/managers/AccountManager.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/AccountManager.ts#L10)
Defined in: [src/core/managers/AccountManager.ts:10](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/AccountManager.ts#L10)
## Constructors
@@ -10,7 +10,7 @@ Defined in: [src/core/managers/AccountManager.ts:10](https://github.com/LuanRT/Y
> **new AccountManager**(`actions`): `AccountManager`
Defined in: [src/core/managers/AccountManager.ts:13](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/AccountManager.ts#L13)
Defined in: [src/core/managers/AccountManager.ts:13](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/AccountManager.ts#L13)
#### Parameters
@@ -30,7 +30,7 @@ Defined in: [src/core/managers/AccountManager.ts:13](https://github.com/LuanRT/Y
> **getInfo**(`all`): `Promise`\<[`AccountItem`](../../YTNodes/classes/AccountItem.md)[]\>
Defined in: [src/core/managers/AccountManager.ts:20](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/AccountManager.ts#L20)
Defined in: [src/core/managers/AccountManager.ts:20](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/AccountManager.ts#L20)
Retrieves the list of channels belonging to the signed-in account. Only useful when signed in through cookie. If signed in through OAuth, you will get the active channel only.
@@ -48,7 +48,7 @@ Retrieves the list of channels belonging to the signed-in account. Only useful w
> **getInfo**(`all?`): `Promise`\<[`AccountInfo`](../../YT/classes/AccountInfo.md)\>
Defined in: [src/core/managers/AccountManager.ts:24](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/AccountManager.ts#L24)
Defined in: [src/core/managers/AccountManager.ts:24](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/AccountManager.ts#L24)
Retrieves the active channel info for the signed-in account. Throws error if `on_behalf_of_user` was used to create the Innertube instance; use `getInfo(true)` instead.
@@ -68,7 +68,7 @@ Retrieves the active channel info for the signed-in account. Throws error if `on
> **getSettings**(): `Promise`\<[`Settings`](../../YT/classes/Settings.md)\>
Defined in: [src/core/managers/AccountManager.ts:50](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/AccountManager.ts#L50)
Defined in: [src/core/managers/AccountManager.ts:50](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/AccountManager.ts#L50)
Gets YouTube settings.

20
docs/api/youtubei.js/namespaces/Managers/classes/InteractionManager.md
View File

@@ -2,7 +2,7 @@
# Class: InteractionManager
Defined in: [src/core/managers/InteractionManager.ts:7](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L7)
Defined in: [src/core/managers/InteractionManager.ts:7](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L7)
## Constructors
@@ -10,7 +10,7 @@ Defined in: [src/core/managers/InteractionManager.ts:7](https://github.com/LuanR
> **new InteractionManager**(`actions`): `InteractionManager`
Defined in: [src/core/managers/InteractionManager.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L10)
Defined in: [src/core/managers/InteractionManager.ts:10](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L10)
#### Parameters
@@ -28,7 +28,7 @@ Defined in: [src/core/managers/InteractionManager.ts:10](https://github.com/Luan
> **comment**(`video_id`, `text`): `Promise`\<[`ApiResponse`](../../../../interfaces/ApiResponse.md)\>
Defined in: [src/core/managers/InteractionManager.ts:119](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L119)
Defined in: [src/core/managers/InteractionManager.ts:119](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L119)
Posts a comment on a given video.
@@ -56,7 +56,7 @@ The comment text
> **dislike**(`video_id`): `Promise`\<[`ApiResponse`](../../../../interfaces/ApiResponse.md)\>
Defined in: [src/core/managers/InteractionManager.ts:38](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L38)
Defined in: [src/core/managers/InteractionManager.ts:38](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L38)
Dislikes a given video.
@@ -78,7 +78,7 @@ The video ID
> **like**(`video_id`): `Promise`\<[`ApiResponse`](../../../../interfaces/ApiResponse.md)\>
Defined in: [src/core/managers/InteractionManager.ts:18](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L18)
Defined in: [src/core/managers/InteractionManager.ts:18](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L18)
Likes a given video.
@@ -100,7 +100,7 @@ The video ID
> **removeRating**(`video_id`): `Promise`\<[`ApiResponse`](../../../../interfaces/ApiResponse.md)\>
Defined in: [src/core/managers/InteractionManager.ts:58](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L58)
Defined in: [src/core/managers/InteractionManager.ts:58](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L58)
Removes a like/dislike.
@@ -122,7 +122,7 @@ The video ID
> **setNotificationPreferences**(`channel_id`, `type`): `Promise`\<[`ApiResponse`](../../../../interfaces/ApiResponse.md)\>
Defined in: [src/core/managers/InteractionManager.ts:174](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L174)
Defined in: [src/core/managers/InteractionManager.ts:174](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L174)
Changes notification preferences for a given channel.
Only works with channels you are subscribed to.
@@ -151,7 +151,7 @@ The notification type.
> **subscribe**(`channel_id`): `Promise`\<[`ApiResponse`](../../../../interfaces/ApiResponse.md)\>
Defined in: [src/core/managers/InteractionManager.ts:78](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L78)
Defined in: [src/core/managers/InteractionManager.ts:78](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L78)
Subscribes to the given channel.
@@ -173,7 +173,7 @@ The channel ID
> **translate**(`text`, `target_language`, `args?`): `Promise`\<\{ `data`: [`IRawResponse`](../../../../interfaces/IRawResponse.md); `status_code`: `number`; `success`: `boolean`; `translated_content`: `any`; \}\>
Defined in: [src/core/managers/InteractionManager.ts:151](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L151)
Defined in: [src/core/managers/InteractionManager.ts:151](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L151)
Translates a given text using YouTube's comment translation feature.
@@ -213,7 +213,7 @@ optional arguments
> **unsubscribe**(`channel_id`): `Promise`\<[`ApiResponse`](../../../../interfaces/ApiResponse.md)\>
Defined in: [src/core/managers/InteractionManager.ts:98](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/InteractionManager.ts#L98)
Defined in: [src/core/managers/InteractionManager.ts:98](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/InteractionManager.ts#L98)
Unsubscribes from the given channel.

22
docs/api/youtubei.js/namespaces/Managers/classes/PlaylistManager.md
View File

@@ -2,7 +2,7 @@
# Class: PlaylistManager
Defined in: [src/core/managers/PlaylistManager.ts:8](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L8)
Defined in: [src/core/managers/PlaylistManager.ts:8](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L8)
## Constructors
@@ -10,7 +10,7 @@ Defined in: [src/core/managers/PlaylistManager.ts:8](https://github.com/LuanRT/Y
> **new PlaylistManager**(`actions`): `PlaylistManager`
Defined in: [src/core/managers/PlaylistManager.ts:11](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L11)
Defined in: [src/core/managers/PlaylistManager.ts:11](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L11)
#### Parameters
@@ -28,7 +28,7 @@ Defined in: [src/core/managers/PlaylistManager.ts:11](https://github.com/LuanRT/
> **addToLibrary**(`playlist_id`): `Promise`\<[`ApiResponse`](../../../../interfaces/ApiResponse.md)\>
Defined in: [src/core/managers/PlaylistManager.ts:73](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L73)
Defined in: [src/core/managers/PlaylistManager.ts:73](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L73)
Adds a given playlist to the library of a user.
@@ -50,7 +50,7 @@ The playlist ID.
> **addVideos**(`playlist_id`, `video_ids`): `Promise`\<\{ `action_result`: `any`; `playlist_id`: `string`; \}\>
Defined in: [src/core/managers/PlaylistManager.ts:114](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L114)
Defined in: [src/core/managers/PlaylistManager.ts:114](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L114)
Adds videos to a given playlist.
@@ -78,7 +78,7 @@ An array of video IDs to add to the playlist.
> **create**(`title`, `video_ids`): `Promise`\<\{ `data`: `any`; `playlist_id?`: `string`; `status_code`: `number`; `success`: `boolean`; \}\>
Defined in: [src/core/managers/PlaylistManager.ts:20](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L20)
Defined in: [src/core/managers/PlaylistManager.ts:20](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L20)
Creates a playlist.
@@ -106,7 +106,7 @@ An array of video IDs to add to the playlist.
> **delete**(`playlist_id`): `Promise`\<\{ `data`: `any`; `playlist_id`: `string`; `status_code`: `number`; `success`: `boolean`; \}\>
Defined in: [src/core/managers/PlaylistManager.ts:47](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L47)
Defined in: [src/core/managers/PlaylistManager.ts:47](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L47)
Deletes a given playlist.
@@ -128,7 +128,7 @@ The playlist ID.
> **moveVideo**(`playlist_id`, `moved_video_id`, `predecessor_video_id`): `Promise`\<\{ `action_result`: `any`; `playlist_id`: `string`; \}\>
Defined in: [src/core/managers/PlaylistManager.ts:194](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L194)
Defined in: [src/core/managers/PlaylistManager.ts:194](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L194)
Moves a video to a new position within a given playlist.
@@ -162,7 +162,7 @@ The video ID to move the moved video before.
> **removeFromLibrary**(`playlist_id`): `Promise`\<[`ApiResponse`](../../../../interfaces/ApiResponse.md)\>
Defined in: [src/core/managers/PlaylistManager.ts:93](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L93)
Defined in: [src/core/managers/PlaylistManager.ts:93](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L93)
Remove a given playlist to the library of a user.
@@ -184,7 +184,7 @@ The playlist ID.
> **removeVideos**(`playlist_id`, `video_ids`, `use_set_video_ids?`): `Promise`\<\{ `action_result`: `any`; `playlist_id`: `string`; \}\>
Defined in: [src/core/managers/PlaylistManager.ts:144](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L144)
Defined in: [src/core/managers/PlaylistManager.ts:144](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L144)
Removes videos from a given playlist.
@@ -218,7 +218,7 @@ Option to remove videos using set video IDs.
> **setDescription**(`playlist_id`, `description`): `Promise`\<\{ `action_result`: `any`; `playlist_id`: `string`; \}\>
Defined in: [src/core/managers/PlaylistManager.ts:282](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L282)
Defined in: [src/core/managers/PlaylistManager.ts:282](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L282)
Sets the description for the given playlist.
@@ -246,7 +246,7 @@ The description to use for the playlist.
> **setName**(`playlist_id`, `name`): `Promise`\<\{ `action_result`: `any`; `playlist_id`: `string`; \}\>
Defined in: [src/core/managers/PlaylistManager.ts:255](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/managers/PlaylistManager.ts#L255)
Defined in: [src/core/managers/PlaylistManager.ts:255](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/managers/PlaylistManager.ts#L255)
Sets the name for the given playlist.