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,7 +26,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L27)
[src/parser/classes/MusicDetailHeader.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L27)
## Properties
@@ -48,7 +48,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L20)
[src/parser/classes/MusicDetailHeader.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L20)
***
@@ -58,7 +58,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L19)
[src/parser/classes/MusicDetailHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L19)
***
@@ -68,7 +68,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L12)
[src/parser/classes/MusicDetailHeader.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L12)
***
@@ -78,7 +78,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L25)
[src/parser/classes/MusicDetailHeader.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L25)
***
@@ -88,7 +88,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L14)
[src/parser/classes/MusicDetailHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L14)
***
@@ -98,7 +98,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L16)
[src/parser/classes/MusicDetailHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L16)
***
@@ -108,7 +108,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L13)
[src/parser/classes/MusicDetailHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L13)
***
@@ -118,7 +118,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L18)
[src/parser/classes/MusicDetailHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L18)
***
@@ -128,7 +128,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L11)
[src/parser/classes/MusicDetailHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L11)
***
@@ -138,7 +138,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L17)
[src/parser/classes/MusicDetailHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L17)
***
@@ -152,7 +152,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)
***
@@ -162,7 +162,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L15)
[src/parser/classes/MusicDetailHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L15)
***
@@ -176,7 +176,7 @@
#### Defined in
[src/parser/classes/MusicDetailHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/MusicDetailHeader.ts#L9)
[src/parser/classes/MusicDetailHeader.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/MusicDetailHeader.ts#L9)
## Methods
@@ -196,17 +196,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)
***
@@ -240,7 +248,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)
***
@@ -274,7 +282,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)
***
@@ -312,4 +320,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)