jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-19 04:21:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: gen docs [skip ci]

Browse Source
This commit is contained in:
Luan
2025-06-08 13:48:03 -03:00
parent e1650e1297
commit f87b5af98c
795 changed files with 9279 additions and 7948 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -26,10 +26,24 @@
#### Defined in
[src/parser/classes/VideoCard.ts:12](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/VideoCard.ts#L12)
[src/parser/classes/VideoCard.ts:12](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/VideoCard.ts#L12)
## Properties
### additional\_metadatas?
> `optional` **additional\_metadatas**: [`Text`](../../Misc/classes/Text.md)[]
#### Inherited from
[`Video`](Video.md).[`additional_metadatas`](Video.md#additional_metadatas)
#### Defined in
[src/parser/classes/Video.ts:22](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L22)
***
### author
> **author**: [`Author`](../../Misc/classes/Author.md)
@@ -40,7 +54,7 @@
#### Defined in
[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L27)
[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L26)
***
@@ -54,7 +68,7 @@
#### Defined in
[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L28)
[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L27)
***
@@ -68,7 +82,7 @@
#### Defined in
[src/parser/classes/VideoCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/VideoCard.ts#L10)
[src/parser/classes/VideoCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/VideoCard.ts#L10)
***
@@ -82,35 +96,13 @@
#### Defined in
[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L18)
[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L19)
***
### duration
### endpoint?
> **duration**: `object`
#### seconds
> **seconds**: `number`
#### text
> **text**: `string`
#### Inherited from
[`Video`](Video.md).[`duration`](Video.md#duration)
#### Defined in
[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L34)
***
### endpoint
> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
#### Inherited from
@@ -118,7 +110,7 @@
#### Defined in
[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L29)
[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L28)
***
@@ -132,21 +124,7 @@
#### Defined in
[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L23)
***
### id
> **id**: `string`
#### Inherited from
[`Video`](Video.md).[`id`](Video.md#id)
#### Defined in
[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L16)
[src/parser/classes/Video.ts:21](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L21)
***
@@ -160,7 +138,21 @@
#### Defined in
[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L39)
[src/parser/classes/Video.ts:35](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L35)
***
### length\_text?
> `optional` **length\_text**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
[`Video`](Video.md).[`length_text`](Video.md#length_text)
#### Defined in
[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L33)
***
@@ -174,7 +166,7 @@
#### Defined in
[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L40)
[src/parser/classes/Video.ts:36](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L36)
***
@@ -184,13 +176,13 @@
#### Defined in
[src/parser/classes/VideoCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/VideoCard.ts#L9)
[src/parser/classes/VideoCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/VideoCard.ts#L9)
***
### published
### published?
> **published**: [`Text`](../../Misc/classes/Text.md)
> `optional` **published**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
@@ -198,7 +190,7 @@
#### Defined in
[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L30)
[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L29)
***
@@ -212,7 +204,7 @@
#### Defined in
[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L26)
[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L25)
***
@@ -226,13 +218,41 @@
#### Defined in
[src/parser/classes/Video.ts:42](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L42)
[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L38)
***
### short\_view\_count
### service\_endpoint?
> **short\_view\_count**: [`Text`](../../Misc/classes/Text.md)
> `optional` **service\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
#### Inherited from
[`Video`](Video.md).[`service_endpoint`](Video.md#service_endpoint)
#### Defined in
[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L40)
***
### service\_endpoints?
> `optional` **service\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[]
#### Inherited from
[`Video`](Video.md).[`service_endpoints`](Video.md#service_endpoints)
#### Defined in
[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L39)
***
### short\_view\_count?
> `optional` **short\_view\_count**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
@@ -240,7 +260,7 @@
#### Defined in
[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L32)
[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L31)
***
@@ -254,7 +274,7 @@
#### Defined in
[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L38)
[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L34)
***
@@ -268,7 +288,21 @@
#### Defined in
[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L19)
[src/parser/classes/Video.ts:20](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L20)
***
### style?
> `optional` **style**: `"VIDEO_STYLE_TYPE_UNKNOWN"` \| `"VIDEO_STYLE_TYPE_NORMAL"` \| `"VIDEO_STYLE_TYPE_POST"` \| `"VIDEO_STYLE_TYPE_SUB"` \| `"VIDEO_STYLE_TYPE_LIVE_POST"` \| `"VIDEO_STYLE_TYPE_FULL_BLEED_ISOLATED"` \| `"VIDEO_STYLE_TYPE_WITH_EXPANDED_METADATA"`
#### Inherited from
[`Video`](Video.md).[`style`](Video.md#style)
#### Defined in
[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L41)
***
@@ -282,7 +316,7 @@
#### Defined in
[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L25)
[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L24)
***
@@ -296,7 +330,7 @@
#### Defined in
[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L24)
[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L23)
***
@@ -310,7 +344,7 @@
#### Defined in
[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L17)
[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L17)
***
@@ -324,7 +358,21 @@
#### Defined in
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/helpers.ts#L8)
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L8)
***
### untranslated\_title?
> `optional` **untranslated\_title**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
[`Video`](Video.md).[`untranslated_title`](Video.md#untranslated_title)
#### Defined in
[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L18)
***
@@ -338,13 +386,27 @@
#### Defined in
[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L33)
[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L32)
***
### view\_count
### video\_id
> **view\_count**: [`Text`](../../Misc/classes/Text.md)
> **video\_id**: `string`
#### Inherited from
[`Video`](Video.md).[`video_id`](Video.md#video_id)
#### Defined in
[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L16)
***
### view\_count?
> `optional` **view\_count**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
@@ -352,7 +414,7 @@
#### Defined in
[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L31)
[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L30)
***
@@ -366,7 +428,7 @@
#### Defined in
[src/parser/classes/VideoCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/VideoCard.ts#L7)
[src/parser/classes/VideoCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/VideoCard.ts#L7)
## Accessors
@@ -384,7 +446,7 @@
#### Defined in
[src/parser/classes/Video.ts:132](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L132)
[src/parser/classes/Video.ts:148](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L148)
***
@@ -402,7 +464,33 @@
#### Defined in
[src/parser/classes/Video.ts:101](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L101)
[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L119)
***
### duration
> `get` **duration**(): `object`
#### Returns
`object`
##### seconds
> **seconds**: `number`
##### text
> **text**: `undefined` \| `string` = `length_text`
#### Inherited from
[`Video`](Video.md).[`duration`](Video.md#duration)
#### Defined in
[src/parser/classes/Video.ts:152](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L152)
***
@@ -420,7 +508,29 @@
#### Defined in
[src/parser/classes/Video.ts:128](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L128)
[src/parser/classes/Video.ts:144](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L144)
***
### id
> `get` **id**(): `string`
#### Deprecated
Use [`video_id`](Video.md#video_id) instead.
#### Returns
`string`
#### Inherited from
[`Video`](Video.md).[`id`](Video.md#id)
#### Defined in
[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L115)
***
@@ -438,7 +548,7 @@
#### Defined in
[src/parser/classes/Video.ts:124](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L124)
[src/parser/classes/Video.ts:140](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L140)
***
@@ -456,7 +566,7 @@
#### Defined in
[src/parser/classes/Video.ts:109](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L109)
[src/parser/classes/Video.ts:125](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L125)
***
@@ -474,7 +584,7 @@
#### Defined in
[src/parser/classes/Video.ts:120](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L120)
[src/parser/classes/Video.ts:136](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L136)
***
@@ -492,7 +602,7 @@
#### Defined in
[src/parser/classes/Video.ts:116](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/classes/Video.ts#L116)
[src/parser/classes/Video.ts:132](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L132)
## Methods
@@ -530,7 +640,7 @@ If the node is not of the given type
#### Defined in
[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/helpers.ts#L38)
[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L29)
***
@@ -564,7 +674,7 @@ Whether the node has the key
#### Defined in
[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/helpers.ts#L50)
[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L41)
***
@@ -598,7 +708,7 @@ whether the node is of the given type
#### Defined in
[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/helpers.ts#L28)
[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L19)
***
@@ -636,4 +746,4 @@ If the node does not have the key
#### Defined in
[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/e54e499ff553dab51e6d9d1aebc090b50fec29ba/src/parser/helpers.ts#L60)
[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L51)