youtubei.js / YT / Settings

Class: Settings

Constructors

new Settings()

new Settings(actions, response): Settings

Parameters

• actions: Actions

• response: ApiResponse

Returns

Settings

Defined in

src/parser/youtube/Settings.ts:28

Properties

introduction?

optional introduction: PageIntroduction

Defined in

src/parser/youtube/Settings.ts:25

---

sections

sections: undefined | object[]

Defined in

src/parser/youtube/Settings.ts:26

---

sidebar?

optional sidebar: SettingsSidebar

Defined in

src/parser/youtube/Settings.ts:24

Accessors

page

get page(): IBrowseResponse

Returns

IBrowseResponse

Defined in

src/parser/youtube/Settings.ts:132

---

setting_options

get setting_options(): string[]

Returns settings available in the page.

Returns

string[]

Defined in

src/parser/youtube/Settings.ts:105

---

sidebar_items

get sidebar_items(): string[]

Returns options available in the sidebar.

Returns

string[]

Defined in

src/parser/youtube/Settings.ts:125

Methods

getSettingOption()

getSettingOption(name): SettingsSwitch

Finds a setting by name and returns it. Use setting_options to see available options.

Parameters

• name: string

Returns

SettingsSwitch

Defined in

src/parser/youtube/Settings.ts:79

---

selectSidebarItem()

selectSidebarItem(target_item): Promise<Settings>

Selects an item from the sidebar menu. Use sidebar_items to see available items.

Parameters

• target_item: string | CompactLink

Returns

Promise<Settings>

Defined in

src/parser/youtube/Settings.ts:55