mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-20 04:51:16 +00:00
chore(docs): Update API ref
This commit is contained in:
@@ -26,7 +26,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:33](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L33)
|
||||
[src/parser/classes/CompactVideo.ts:33](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L33)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -36,7 +36,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L18)
|
||||
[src/parser/classes/CompactVideo.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L18)
|
||||
|
||||
***
|
||||
|
||||
@@ -46,7 +46,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L22)
|
||||
[src/parser/classes/CompactVideo.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L22)
|
||||
|
||||
***
|
||||
|
||||
@@ -64,7 +64,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L24)
|
||||
[src/parser/classes/CompactVideo.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L24)
|
||||
|
||||
***
|
||||
|
||||
@@ -74,7 +74,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:30](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L30)
|
||||
[src/parser/classes/CompactVideo.ts:30](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L30)
|
||||
|
||||
***
|
||||
|
||||
@@ -84,7 +84,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L14)
|
||||
[src/parser/classes/CompactVideo.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L14)
|
||||
|
||||
***
|
||||
|
||||
@@ -94,7 +94,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:31](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L31)
|
||||
[src/parser/classes/CompactVideo.ts:31](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L31)
|
||||
|
||||
***
|
||||
|
||||
@@ -104,7 +104,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L21)
|
||||
[src/parser/classes/CompactVideo.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L21)
|
||||
|
||||
***
|
||||
|
||||
@@ -114,7 +114,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L16)
|
||||
[src/parser/classes/CompactVideo.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L16)
|
||||
|
||||
***
|
||||
|
||||
@@ -124,7 +124,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L20)
|
||||
[src/parser/classes/CompactVideo.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L20)
|
||||
|
||||
***
|
||||
|
||||
@@ -134,7 +134,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:29](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L29)
|
||||
[src/parser/classes/CompactVideo.ts:29](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L29)
|
||||
|
||||
***
|
||||
|
||||
@@ -144,7 +144,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L15)
|
||||
[src/parser/classes/CompactVideo.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L15)
|
||||
|
||||
***
|
||||
|
||||
@@ -154,7 +154,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L17)
|
||||
[src/parser/classes/CompactVideo.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L17)
|
||||
|
||||
***
|
||||
|
||||
@@ -168,7 +168,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)
|
||||
|
||||
***
|
||||
|
||||
@@ -178,7 +178,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L19)
|
||||
[src/parser/classes/CompactVideo.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L19)
|
||||
|
||||
***
|
||||
|
||||
@@ -192,7 +192,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L12)
|
||||
[src/parser/classes/CompactVideo.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L12)
|
||||
|
||||
## Accessors
|
||||
|
||||
@@ -206,7 +206,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:59](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L59)
|
||||
[src/parser/classes/CompactVideo.ts:59](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L59)
|
||||
|
||||
***
|
||||
|
||||
@@ -220,7 +220,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:63](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L63)
|
||||
[src/parser/classes/CompactVideo.ts:63](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L63)
|
||||
|
||||
***
|
||||
|
||||
@@ -234,7 +234,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:67](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L67)
|
||||
[src/parser/classes/CompactVideo.ts:67](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L67)
|
||||
|
||||
***
|
||||
|
||||
@@ -248,7 +248,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:74](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L74)
|
||||
[src/parser/classes/CompactVideo.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L74)
|
||||
|
||||
***
|
||||
|
||||
@@ -262,7 +262,7 @@
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/CompactVideo.ts:78](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/CompactVideo.ts#L78)
|
||||
[src/parser/classes/CompactVideo.ts:78](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/CompactVideo.ts#L78)
|
||||
|
||||
## Methods
|
||||
|
||||
@@ -282,17 +282,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)
|
||||
|
||||
***
|
||||
|
||||
@@ -326,7 +334,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)
|
||||
|
||||
***
|
||||
|
||||
@@ -360,7 +368,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)
|
||||
|
||||
***
|
||||
|
||||
@@ -398,4 +406,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)
|
||||
|
||||
Reference in New Issue
Block a user