mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-16 11:02:10 +00:00
2bbefefbb7
* dev: add `WEB_KIDS` innertube client * refactor: move DASH manifest stuff out of `VideoInfo` This makes it easier to use these functions elsewhere. * feat(ytkids): add `Kids#getInfo()` & `Kids#search()` * feat: add `Innertube#kids.getHomeFeed()` * docs: add YouTube Kids API ref * docs: fix typo * docs: fix yet another typo * docs: update YouTube Music API ref Unrelated but required to reflect changes made to the DASH manifest generation functions * chore: lint * chore: add tests * feat: include `captions` in `VideoInfo` * chore: fix tests
115 lines
2.1 KiB
Markdown
115 lines
2.1 KiB
Markdown
# Account
|
|
|
|
YouTube account manager.
|
|
|
|
## API
|
|
|
|
* Account
|
|
* [.channel](#channel)
|
|
* [.getInfo()](#getinfo)
|
|
* [.getTimeWatched()](#gettimewatched)
|
|
* [.getSettings()](#getsettings)
|
|
* [.getAnalytics](#getanalytics)
|
|
|
|
<a name="channel"></a>
|
|
### channel
|
|
|
|
Channel settings.
|
|
|
|
**Returns:** `object`
|
|
|
|
<details>
|
|
<summary>Methods & Getters</summary>
|
|
<p>
|
|
|
|
- `<channel>#editName(new_name)`
|
|
- Edits the name of the channel.
|
|
|
|
- `<channel>#editDescription(new_description)`
|
|
- Edits channel description.
|
|
|
|
- `<channel>#getBasicAnalytics()`
|
|
- Alias for [`Account#getAnalytics()`](#getanalytics) — returns basic channel analytics.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<a name="getinfo"></a>
|
|
### getInfo()
|
|
|
|
Retrieves account information.
|
|
|
|
**Returns:** `Promise.<AccountInfo>`
|
|
|
|
<details>
|
|
<summary>Methods & Getters</summary>
|
|
<p>
|
|
|
|
- `<accountinfo>#page`
|
|
- Returns the original InnerTube response(s), parsed and sanitized.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<a name="gettimewatched"></a>
|
|
### getTimeWatched()
|
|
|
|
Retrieves time watched statistics.
|
|
|
|
**Returns:** `Promise.<TimeWatched>`
|
|
|
|
<details>
|
|
<summary>Methods & Getters</summary>
|
|
<p>
|
|
|
|
- `<timewatched>#page`
|
|
- Returns the original InnerTube response(s), parsed and sanitized.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<a name="getsettings"></a>
|
|
### getSettings()
|
|
|
|
Retrieves YouTube settings.
|
|
|
|
**Returns:** `Promise.<Settings>`
|
|
|
|
<details>
|
|
<summary>Methods & Getters</summary>
|
|
<p>
|
|
|
|
- `<settings>#selectSidebarItem(name)`
|
|
- Selects an item from the sidebar menu. Use `settings#sidebar_items` to see available items.
|
|
|
|
- `<settings>#getSettingOption(name)`
|
|
- Finds a setting by name and returns it. Use `settings#setting_options` to see available options.
|
|
|
|
- `<settings>#setting_options`
|
|
- Returns settings available in the page.
|
|
|
|
- `<settings>#sidebar_items`
|
|
- Returns options available in the sidebar menu.
|
|
|
|
- `<settings>#page`
|
|
- Returns the original InnerTube response(s), parsed and sanitized.
|
|
|
|
</p>
|
|
</details>
|
|
|
|
<a name="getanalytics"></a>
|
|
### getAnalytics()
|
|
|
|
Retrieves basic channel analytics.
|
|
|
|
**Returns:** `Promise.<Analytics>`
|
|
|
|
<details>
|
|
<summary>Methods & Getters</summary>
|
|
<p>
|
|
|
|
- `<analytics>#page`
|
|
- Returns the original InnerTube response(s), parsed and sanitized.
|
|
|
|
</p>
|
|
</details> |