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

chore(docs): update

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/api/youtubei.js/namespaces/YTNodes/classes/StructuredDescriptionContent.md
View File

@@ -2,7 +2,7 @@
# Class: StructuredDescriptionContent
Defined in: [src/parser/classes/StructuredDescriptionContent.ts:14](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/StructuredDescriptionContent.ts#L14)
Defined in: [src/parser/classes/StructuredDescriptionContent.ts:16](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/StructuredDescriptionContent.ts#L16)
## Extends
@@ -14,7 +14,7 @@ Defined in: [src/parser/classes/StructuredDescriptionContent.ts:14](https://gith
> **new StructuredDescriptionContent**(`data`): `StructuredDescriptionContent`
Defined in: [src/parser/classes/StructuredDescriptionContent.ts:24](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/StructuredDescriptionContent.ts#L24)
Defined in: [src/parser/classes/StructuredDescriptionContent.ts:26](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/StructuredDescriptionContent.ts#L26)
#### Parameters
@@ -34,9 +34,9 @@ Defined in: [src/parser/classes/StructuredDescriptionContent.ts:24](https://gith
### items
> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](ReelShelf.md) \| [`HorizontalCardList`](HorizontalCardList.md) \| [`ExpandableVideoDescriptionBody`](ExpandableVideoDescriptionBody.md) \| [`VideoDescriptionHeader`](VideoDescriptionHeader.md) \| [`VideoDescriptionInfocardsSection`](VideoDescriptionInfocardsSection.md) \| [`VideoDescriptionMusicSection`](VideoDescriptionMusicSection.md) \| [`VideoDescriptionTranscriptSection`](VideoDescriptionTranscriptSection.md) \| [`VideoDescriptionCourseSection`](VideoDescriptionCourseSection.md) \| [`VideoAttributesSectionView`](VideoAttributesSectionView.md) \| [`HowThisWasMadeSectionView`](HowThisWasMadeSectionView.md)\>
> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](ReelShelf.md) \| [`HorizontalCardList`](HorizontalCardList.md) \| [`ExpandableMetadata`](ExpandableMetadata.md) \| [`ExpandableVideoDescriptionBody`](ExpandableVideoDescriptionBody.md) \| [`VideoDescriptionHeader`](VideoDescriptionHeader.md) \| [`VideoDescriptionInfocardsSection`](VideoDescriptionInfocardsSection.md) \| [`VideoDescriptionMusicSection`](VideoDescriptionMusicSection.md) \| [`VideoDescriptionTranscriptSection`](VideoDescriptionTranscriptSection.md) \| [`VideoDescriptionCourseSection`](VideoDescriptionCourseSection.md) \| [`VideoAttributesSectionView`](VideoAttributesSectionView.md) \| [`HowThisWasMadeSectionView`](HowThisWasMadeSectionView.md) \| [`MerchandiseShelf`](MerchandiseShelf.md)\>
Defined in: [src/parser/classes/StructuredDescriptionContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/StructuredDescriptionContent.ts#L17)
Defined in: [src/parser/classes/StructuredDescriptionContent.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/StructuredDescriptionContent.ts#L19)
***
@@ -44,7 +44,7 @@ Defined in: [src/parser/classes/StructuredDescriptionContent.ts:17](https://gith
> `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
@@ -56,7 +56,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
> `static` **type**: `string` = `'StructuredDescriptionContent'`
Defined in: [src/parser/classes/StructuredDescriptionContent.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/StructuredDescriptionContent.ts#L15)
Defined in: [src/parser/classes/StructuredDescriptionContent.ts:17](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/StructuredDescriptionContent.ts#L17)
#### Overrides
@@ -68,7 +68,7 @@ Defined in: [src/parser/classes/StructuredDescriptionContent.ts:15](https://gith
> **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.
@@ -110,7 +110,7 @@ If the node is not of the given type
> **hasKey**\<`T`, `R`\>(`key`): `this is StructuredDescriptionContent & { [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.
@@ -148,7 +148,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.
@@ -186,7 +186,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.