chore(docs): Update API ref

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

View File

@@ -26,17 +26,17 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L28)
[src/parser/classes/MusicResponsiveHeader.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L28)
## Properties
### buttons
> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`Menu`](Menu.md) \| [`ToggleButton`](ToggleButton.md) \| [`MusicPlayButton`](MusicPlayButton.md) \| [`DownloadButton`](DownloadButton.md)\>
> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Button`](Button.md) \| [`DownloadButton`](DownloadButton.md) \| [`ToggleButton`](ToggleButton.md) \| [`Menu`](Menu.md) \| [`MusicPlayButton`](MusicPlayButton.md)\>
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L19)
[src/parser/classes/MusicResponsiveHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L19)
***
@@ -46,7 +46,7 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L26)
[src/parser/classes/MusicResponsiveHeader.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L26)
***
@@ -56,7 +56,7 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L24)
[src/parser/classes/MusicResponsiveHeader.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L24)
***
@@ -66,7 +66,7 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L22)
[src/parser/classes/MusicResponsiveHeader.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L22)
***
@@ -76,7 +76,7 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L23)
[src/parser/classes/MusicResponsiveHeader.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L23)
***
@@ -86,7 +86,7 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L21)
[src/parser/classes/MusicResponsiveHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L21)
***
@@ -96,7 +96,7 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L25)
[src/parser/classes/MusicResponsiveHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L25)
***
@@ -106,7 +106,7 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L18)
[src/parser/classes/MusicResponsiveHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L18)
***
@@ -116,7 +116,7 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L20)
[src/parser/classes/MusicResponsiveHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L20)
***
@@ -130,7 +130,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)
***
@@ -144,7 +144,7 @@
#### Defined in
[src/parser/classes/MusicResponsiveHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicResponsiveHeader.ts#L16)
[src/parser/classes/MusicResponsiveHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicResponsiveHeader.ts#L16)
## Methods
@@ -164,17 +164,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)
***
@@ -208,7 +216,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)
***
@@ -242,7 +250,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)
***
@@ -280,4 +288,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)