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

76
docs/api/namespaces/YTNodes/classes/VideoCard.md
View File

@@ -26,7 +26,7 @@
#### Defined in
[src/parser/classes/VideoCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoCard.ts#L7)
[src/parser/classes/VideoCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoCard.ts#L9)
## Properties
@@ -40,7 +40,7 @@
#### Defined in
[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L27)
[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L27)
***
@@ -54,7 +54,7 @@
#### Defined in
[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L28)
[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L28)
***
@@ -68,7 +68,7 @@
#### Defined in
[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L18)
[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L18)
***
@@ -90,7 +90,7 @@
#### Defined in
[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L34)
[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L34)
***
@@ -104,7 +104,7 @@
#### Defined in
[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L29)
[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L29)
***
@@ -118,7 +118,7 @@
#### Defined in
[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L23)
[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L23)
***
@@ -132,7 +132,7 @@
#### Defined in
[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L16)
[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L16)
***
@@ -146,7 +146,7 @@
#### Defined in
[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L39)
[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L39)
***
@@ -160,7 +160,7 @@
#### Defined in
[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L40)
[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L40)
***
@@ -174,7 +174,7 @@
#### Defined in
[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L30)
[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L30)
***
@@ -188,7 +188,7 @@
#### Defined in
[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L26)
[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L26)
***
@@ -202,7 +202,7 @@
#### Defined in
[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L41)
[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L41)
***
@@ -216,7 +216,7 @@
#### Defined in
[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L32)
[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L32)
***
@@ -230,7 +230,7 @@
#### Defined in
[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L38)
[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L38)
***
@@ -244,7 +244,7 @@
#### Defined in
[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L19)
[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L19)
***
@@ -258,7 +258,7 @@
#### Defined in
[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L25)
[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L25)
***
@@ -272,7 +272,7 @@
#### Defined in
[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L24)
[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L24)
***
@@ -286,7 +286,7 @@
#### Defined in
[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L17)
[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L17)
***
@@ -300,7 +300,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)
***
@@ -314,7 +314,7 @@
#### Defined in
[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L33)
[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L33)
***
@@ -328,7 +328,7 @@
#### Defined in
[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L31)
[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L31)
***
@@ -342,7 +342,7 @@
#### Defined in
[src/parser/classes/VideoCard.ts:5](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/VideoCard.ts#L5)
[src/parser/classes/VideoCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/VideoCard.ts#L7)
## Accessors
@@ -360,7 +360,7 @@
#### Defined in
[src/parser/classes/Video.ts:127](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L127)
[src/parser/classes/Video.ts:127](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L127)
***
@@ -378,7 +378,7 @@
#### Defined in
[src/parser/classes/Video.ts:96](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L96)
[src/parser/classes/Video.ts:96](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L96)
***
@@ -396,7 +396,7 @@
#### Defined in
[src/parser/classes/Video.ts:123](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L123)
[src/parser/classes/Video.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L123)
***
@@ -414,7 +414,7 @@
#### Defined in
[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L119)
[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L119)
***
@@ -432,7 +432,7 @@
#### Defined in
[src/parser/classes/Video.ts:104](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L104)
[src/parser/classes/Video.ts:104](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L104)
***
@@ -450,7 +450,7 @@
#### Defined in
[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L115)
[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L115)
***
@@ -468,7 +468,7 @@
#### Defined in
[src/parser/classes/Video.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/Video.ts#L111)
[src/parser/classes/Video.ts:111](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/Video.ts#L111)
## Methods
@@ -488,17 +488,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
[`Video`](Video.md).[`as`](Video.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)
***
@@ -532,7 +540,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)
***
@@ -566,7 +574,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)
***
@@ -604,4 +612,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)