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

chore(docs): Update API ref

Browse Source
This commit is contained in:
Luan
2024-11-22 04:25:16 -03:00
parent fc5571629e
commit 4e9d64404e
927 changed files with 26023 additions and 9839 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
docs/api/namespaces/Managers/classes/AccountManager.md
View File

@@ -18,72 +18,10 @@
#### Defined in
[src/core/managers/AccountManager.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L23)
## Properties
### channel
> **channel**: `object`
#### editDescription()
> **editDescription**: (`new_description`) => `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
##### Parameters
• **new\_description**: `string`
##### Returns
`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
#### editName()
> **editName**: (`new_name`) => `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
##### Parameters
• **new\_name**: `string`
##### Returns
`Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
#### getBasicAnalytics()
> **getBasicAnalytics**: () => `Promise`\<[`Analytics`](../../YT/classes/Analytics.md)\>
##### Returns
`Promise`\<[`Analytics`](../../YT/classes/Analytics.md)\>
#### Defined in
[src/core/managers/AccountManager.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L17)
[src/core/managers/AccountManager.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/AccountManager.ts#L12)
## Methods
### ~~getAnalytics()~~
> **getAnalytics**(): `Promise`\<[`Analytics`](../../YT/classes/Analytics.md)\>
Retrieves basic channel analytics.
#### Returns
`Promise`\<[`Analytics`](../../YT/classes/Analytics.md)\>
#### Deprecated
This method is deprecated and will be removed in a future release.
#### Defined in
[src/core/managers/AccountManager.ts:113](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L113)
***
### getInfo()
> **getInfo**(): `Promise`\<[`AccountInfo`](../../YT/classes/AccountInfo.md)\>
@@ -96,7 +34,7 @@ Retrieves channel info.
#### Defined in
[src/core/managers/AccountManager.ts:70](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L70)
[src/core/managers/AccountManager.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/AccountManager.ts#L19)
***
@@ -104,7 +42,7 @@ Retrieves channel info.
> **getSettings**(): `Promise`\<[`Settings`](../../YT/classes/Settings.md)\>
Opens YouTube settings.
Gets YouTube settings.
#### Returns
@@ -112,24 +50,4 @@ Opens YouTube settings.
#### Defined in
[src/core/managers/AccountManager.ts:100](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L100)
***
### ~~getTimeWatched()~~
> **getTimeWatched**(): `Promise`\<[`TimeWatched`](../../YT/classes/TimeWatched.md)\>
Retrieves time watched statistics.
#### Returns
`Promise`\<[`TimeWatched`](../../YT/classes/TimeWatched.md)\>
#### Deprecated
This method is deprecated and will be removed in a future release.
#### Defined in
[src/core/managers/AccountManager.ts:86](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/AccountManager.ts#L86)
[src/core/managers/AccountManager.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/AccountManager.ts#L30)

26
docs/api/namespaces/Managers/classes/InteractionManager.md
View File

@@ -18,7 +18,7 @@
#### Defined in
[src/core/managers/InteractionManager.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L16)
[src/core/managers/InteractionManager.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L10)
## Methods
@@ -44,7 +44,7 @@ The comment text
#### Defined in
[src/core/managers/InteractionManager.ts:122](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L122)
[src/core/managers/InteractionManager.ts:119](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L119)
***
@@ -66,7 +66,7 @@ The video ID
#### Defined in
[src/core/managers/InteractionManager.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L43)
[src/core/managers/InteractionManager.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L38)
***
@@ -88,7 +88,7 @@ The video ID
#### Defined in
[src/core/managers/InteractionManager.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L24)
[src/core/managers/InteractionManager.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L18)
***
@@ -110,7 +110,7 @@ The video ID
#### Defined in
[src/core/managers/InteractionManager.ts:62](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L62)
[src/core/managers/InteractionManager.ts:58](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L58)
***
@@ -137,7 +137,7 @@ The notification type.
#### Defined in
[src/core/managers/InteractionManager.ts:181](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L181)
[src/core/managers/InteractionManager.ts:174](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L174)
***
@@ -145,7 +145,7 @@ The notification type.
> **subscribe**(`channel_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
Subscribes to a given channel.
Subscribes to the given channel.
#### Parameters
@@ -159,7 +159,7 @@ The channel ID
#### Defined in
[src/core/managers/InteractionManager.ts:81](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L81)
[src/core/managers/InteractionManager.ts:78](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L78)
***
@@ -167,12 +167,14 @@ The channel ID
> **translate**(`text`, `target_language`, `args`): `Promise`\<`object`\>
Translates a given text using YouTube's comment translate feature.
Translates a given text using YouTube's comment translation feature.
#### Parameters
• **text**: `string`
The text to translate
• **target\_language**: `string`
an ISO language code
@@ -207,7 +209,7 @@ optional arguments
#### Defined in
[src/core/managers/InteractionManager.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L154)
[src/core/managers/InteractionManager.ts:151](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L151)
***
@@ -215,7 +217,7 @@ optional arguments
> **unsubscribe**(`channel_id`): `Promise`\<[`ApiResponse`](../../../interfaces/ApiResponse.md)\>
Unsubscribes from a given channel.
Unsubscribes from the given channel.
#### Parameters
@@ -229,4 +231,4 @@ The channel ID
#### Defined in
[src/core/managers/InteractionManager.ts:101](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/InteractionManager.ts#L101)
[src/core/managers/InteractionManager.ts:98](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/InteractionManager.ts#L98)

18
docs/api/namespaces/Managers/classes/PlaylistManager.md
View File

@@ -18,7 +18,7 @@
#### Defined in
[src/core/managers/PlaylistManager.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L14)
[src/core/managers/PlaylistManager.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L11)
## Methods
@@ -52,7 +52,7 @@ An array of video IDs to add to the playlist.
#### Defined in
[src/core/managers/PlaylistManager.ts:73](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L73)
[src/core/managers/PlaylistManager.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L74)
***
@@ -94,7 +94,7 @@ An array of video IDs to add to the playlist.
#### Defined in
[src/core/managers/PlaylistManager.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L23)
[src/core/managers/PlaylistManager.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L20)
***
@@ -132,7 +132,7 @@ The playlist ID.
#### Defined in
[src/core/managers/PlaylistManager.ts:48](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L48)
[src/core/managers/PlaylistManager.ts:47](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L47)
***
@@ -170,7 +170,7 @@ The video ID to move the moved video before.
#### Defined in
[src/core/managers/PlaylistManager.ts:156](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L156)
[src/core/managers/PlaylistManager.ts:154](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L154)
***
@@ -208,7 +208,7 @@ Option to remove videos using set video IDs.
#### Defined in
[src/core/managers/PlaylistManager.ts:101](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L101)
[src/core/managers/PlaylistManager.ts:104](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L104)
***
@@ -242,7 +242,7 @@ The description to use for the playlist.
#### Defined in
[src/core/managers/PlaylistManager.ts:239](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L239)
[src/core/managers/PlaylistManager.ts:243](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L243)
***
@@ -250,7 +250,7 @@ The description to use for the playlist.
> **setName**(`playlist_id`, `name`): `Promise`\<`object`\>
Sets the name (title) for the given playlist.
Sets the name for the given playlist.
#### Parameters
@@ -276,4 +276,4 @@ The name / title to use for the playlist.
#### Defined in
[src/core/managers/PlaylistManager.ts:211](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/core/managers/PlaylistManager.ts#L211)
[src/core/managers/PlaylistManager.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/core/managers/PlaylistManager.ts#L216)