mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-18 03:59:38 +00:00
74659fd03f
* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
140 lines
3.4 KiB
Markdown
140 lines
3.4 KiB
Markdown
[youtubei.js](../../../README.md) / [YT](../README.md) / Settings
|
|
|
|
# Class: Settings
|
|
|
|
## Constructors
|
|
|
|
### new Settings()
|
|
|
|
> **new Settings**(`actions`, `response`): [`Settings`](Settings.md)
|
|
|
|
#### Parameters
|
|
|
|
• **actions**: [`Actions`](../../../classes/Actions.md)
|
|
|
|
• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md)
|
|
|
|
#### Returns
|
|
|
|
[`Settings`](Settings.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/youtube/Settings.ts:28](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Settings.ts#L28)
|
|
|
|
## Properties
|
|
|
|
### introduction?
|
|
|
|
> `optional` **introduction**: [`PageIntroduction`](../../YTNodes/classes/PageIntroduction.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/youtube/Settings.ts:25](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Settings.ts#L25)
|
|
|
|
***
|
|
|
|
### sections
|
|
|
|
> **sections**: `undefined` \| `object`[]
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/youtube/Settings.ts:26](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Settings.ts#L26)
|
|
|
|
***
|
|
|
|
### sidebar?
|
|
|
|
> `optional` **sidebar**: [`SettingsSidebar`](../../YTNodes/classes/SettingsSidebar.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/youtube/Settings.ts:24](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Settings.ts#L24)
|
|
|
|
## Accessors
|
|
|
|
### page
|
|
|
|
> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)
|
|
|
|
#### Returns
|
|
|
|
[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/youtube/Settings.ts:132](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Settings.ts#L132)
|
|
|
|
***
|
|
|
|
### setting\_options
|
|
|
|
> `get` **setting\_options**(): `string`[]
|
|
|
|
Returns settings available in the page.
|
|
|
|
#### Returns
|
|
|
|
`string`[]
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/youtube/Settings.ts:105](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Settings.ts#L105)
|
|
|
|
***
|
|
|
|
### sidebar\_items
|
|
|
|
> `get` **sidebar\_items**(): `string`[]
|
|
|
|
Returns options available in the sidebar.
|
|
|
|
#### Returns
|
|
|
|
`string`[]
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/youtube/Settings.ts:125](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Settings.ts#L125)
|
|
|
|
## Methods
|
|
|
|
### getSettingOption()
|
|
|
|
> **getSettingOption**(`name`): [`SettingsSwitch`](../../YTNodes/classes/SettingsSwitch.md)
|
|
|
|
Finds a setting by name and returns it. Use [setting_options](Settings.md#setting_options) to see available options.
|
|
|
|
#### Parameters
|
|
|
|
• **name**: `string`
|
|
|
|
#### Returns
|
|
|
|
[`SettingsSwitch`](../../YTNodes/classes/SettingsSwitch.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/youtube/Settings.ts:79](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Settings.ts#L79)
|
|
|
|
***
|
|
|
|
### selectSidebarItem()
|
|
|
|
> **selectSidebarItem**(`target_item`): `Promise`\<[`Settings`](Settings.md)\>
|
|
|
|
Selects an item from the sidebar menu. Use [sidebar_items](Settings.md#sidebar_items) to see available items.
|
|
|
|
#### Parameters
|
|
|
|
• **target\_item**: `string` \| [`CompactLink`](../../YTNodes/classes/CompactLink.md)
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<[`Settings`](Settings.md)\>
|
|
|
|
#### Defined in
|
|
|
|
[src/parser/youtube/Settings.ts:55](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Settings.ts#L55)
|