chore(docs): update

This commit is contained in:
LuanRT
2026-05-07 14:38:16 -03:00
parent faaf5fc5c1
commit 03cb4d6801
859 changed files with 11610 additions and 9101 deletions

View File

@@ -2,7 +2,7 @@
# Class: VideoDescriptionHeader
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L10)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L10)
## Extends
@@ -14,7 +14,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:10](https://github.com
> **new VideoDescriptionHeader**(`data`): `VideoDescriptionHeader`
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L21)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:21](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L21)
#### Parameters
@@ -36,7 +36,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:21](https://github.com
> **channel**: [`Text`](../../Misc/classes/Text.md)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L13)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:13](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L13)
***
@@ -44,7 +44,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:13](https://github.com
> `optional` **channel\_navigation\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L14)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:14](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L14)
***
@@ -52,7 +52,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:14](https://github.com
> **channel\_thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[]
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L15)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L15)
***
@@ -60,7 +60,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:15](https://github.com
> **factoids**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Factoid`](Factoid.md) \| [`UploadTimeFactoid`](UploadTimeFactoid.md) \| [`ViewCountFactoid`](ViewCountFactoid.md) \| [`HypePointsFactoid`](HypePointsFactoid.md)\>
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L16)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:16](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L16)
***
@@ -68,7 +68,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:16](https://github.com
> **publish\_date**: [`Text`](../../Misc/classes/Text.md)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L17)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:17](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L17)
***
@@ -76,7 +76,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:17](https://github.com
> **title**: [`Text`](../../Misc/classes/Text.md)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L18)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:18](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L18)
***
@@ -84,7 +84,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:18](https://github.com
> `readonly` **type**: `string`
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L8)
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L8)
#### Inherited from
@@ -96,7 +96,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
> **views**: [`Text`](../../Misc/classes/Text.md)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L19)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L19)
***
@@ -104,7 +104,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:19](https://github.com
> `static` **type**: `string` = `'VideoDescriptionHeader'`
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/VideoDescriptionHeader.ts#L11)
Defined in: [src/parser/classes/VideoDescriptionHeader.ts:11](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/VideoDescriptionHeader.ts#L11)
#### Overrides
@@ -116,7 +116,7 @@ Defined in: [src/parser/classes/VideoDescriptionHeader.ts:11](https://github.com
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L29)
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L29)
Cast to one of the given types.
@@ -158,7 +158,7 @@ If the node is not of the given type
> **hasKey**\<`T`, `R`\>(`key`): `this is VideoDescriptionHeader & { [k in string]: R }`
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L41)
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L41)
Check for a key without asserting the type.
@@ -196,7 +196,7 @@ Whether the node has the key
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L19)
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L19)
Check if the node is of the given type.
@@ -234,7 +234,7 @@ whether the node is of the given type
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md)
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L51)
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L51)
Assert that the node has the given key and return it.