chore(docs): Update API ref

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

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)