jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-26 16:18:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: add proper documentation (#763)

Browse Source 
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
This commit is contained in:
Luan
2024-09-23 17:32:50 -03:00
committed by GitHub
parent dd7f5cf778
commit 74659fd03f
853 changed files with 139814 additions and 1929 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
docs/api/namespaces/YT/classes/ItemMenu.md Normal file
View File

@@ -0,0 +1,87 @@
[youtubei.js](../../../README.md) / [YT](../README.md) / ItemMenu
# Class: ItemMenu
## Constructors
### new ItemMenu()
> **new ItemMenu**(`data`, `actions`): [`ItemMenu`](ItemMenu.md)
#### Parameters
• **data**: [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)
• **actions**: [`Actions`](../../../classes/Actions.md)
#### Returns
[`ItemMenu`](ItemMenu.md)
#### Defined in
[src/parser/youtube/ItemMenu.ts:16](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/ItemMenu.ts#L16)
## Methods
### items()
> **items**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
#### Returns
[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
#### Defined in
[src/parser/youtube/ItemMenu.ts:61](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/ItemMenu.ts#L61)
***
### page()
> **page**(): [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)
#### Returns
[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)
#### Defined in
[src/parser/youtube/ItemMenu.ts:65](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/ItemMenu.ts#L65)
***
### selectItem()
#### selectItem(icon_type)
> **selectItem**(`icon_type`): `Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\>
##### Parameters
• **icon\_type**: `string`
##### Returns
`Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\>
##### Defined in
[src/parser/youtube/ItemMenu.ts:28](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/ItemMenu.ts#L28)
#### selectItem(button)
> **selectItem**(`button`): `Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\>
##### Parameters
• **button**: [`Button`](../../YTNodes/classes/Button.md)
##### Returns
`Promise`\<[`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)\>
##### Defined in
[src/parser/youtube/ItemMenu.ts:29](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/ItemMenu.ts#L29)