jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-18 20:12:12 +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

42
docs/api/namespaces/YTNodes/classes/Menu.md
View File

@@ -26,17 +26,27 @@
#### Defined in
[src/parser/classes/menus/Menu.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L13)
[src/parser/classes/menus/Menu.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L20)
## Properties
### flexible\_items
> **flexible\_items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MenuFlexibleItem`](MenuFlexibleItem.md)\>
#### Defined in
[src/parser/classes/menus/Menu.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L16)
***
### items
> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
#### Defined in
[src/parser/classes/menus/Menu.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L9)
[src/parser/classes/menus/Menu.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L15)
***
@@ -46,17 +56,17 @@
#### Defined in
[src/parser/classes/menus/Menu.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L11)
[src/parser/classes/menus/Menu.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L18)
***
### top\_level\_buttons
> **top\_level\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
> **top\_level\_buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`ButtonView`](ButtonView.md) \| [`SegmentedLikeDislikeButtonView`](SegmentedLikeDislikeButtonView.md) \| [`LikeButton`](LikeButton.md) \| [`ToggleButton`](ToggleButton.md)\>
#### Defined in
[src/parser/classes/menus/Menu.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L10)
[src/parser/classes/menus/Menu.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L17)
***
@@ -70,7 +80,7 @@
#### Defined in
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8)
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8)
***
@@ -84,7 +94,7 @@
#### Defined in
[src/parser/classes/menus/Menu.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L7)
[src/parser/classes/menus/Menu.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L13)
## Accessors
@@ -98,7 +108,7 @@
#### Defined in
[src/parser/classes/menus/Menu.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/menus/Menu.ts#L24)
[src/parser/classes/menus/Menu.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/menus/Menu.ts#L32)
## Methods
@@ -118,17 +128,25 @@ Cast to one of the given types.
• ...**types**: `K`
The types to cast to
#### Returns
`InstanceType`\<`K`\[`number`\]\>
The node cast to one of the given types
#### Throws
If the node is not of the given type
#### Inherited from
[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as)
#### Defined in
[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35)
[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38)
***
@@ -162,7 +180,7 @@ Whether the node has the key
#### Defined in
[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47)
[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50)
***
@@ -196,7 +214,7 @@ whether the node is of the given type
#### Defined in
[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28)
[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28)
***
@@ -234,4 +252,4 @@ If the node does not have the key
#### Defined in
[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57)
[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60)