jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-07-04 03:51:00 +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

28
docs/api/youtubei.js/namespaces/YTNodes/classes/CarouselItem.md
View File

@@ -2,7 +2,7 @@
# Class: CarouselItem
Defined in: [src/parser/classes/CarouselItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/CarouselItem.ts#L5)
Defined in: [src/parser/classes/CarouselItem.ts:5](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/CarouselItem.ts#L5)
## Extends
@@ -14,7 +14,7 @@ Defined in: [src/parser/classes/CarouselItem.ts:5](https://github.com/LuanRT/You
> **new CarouselItem**(`data`): `CarouselItem`
Defined in: [src/parser/classes/CarouselItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/CarouselItem.ts#L14)
Defined in: [src/parser/classes/CarouselItem.ts:14](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/CarouselItem.ts#L14)
#### Parameters
@@ -36,7 +36,7 @@ Defined in: [src/parser/classes/CarouselItem.ts:14](https://github.com/LuanRT/Yo
> **background\_color**: `string`
Defined in: [src/parser/classes/CarouselItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/CarouselItem.ts#L9)
Defined in: [src/parser/classes/CarouselItem.ts:9](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/CarouselItem.ts#L9)
***
@@ -44,7 +44,7 @@ Defined in: [src/parser/classes/CarouselItem.ts:9](https://github.com/LuanRT/You
> **items**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
Defined in: [src/parser/classes/CarouselItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/CarouselItem.ts#L8)
Defined in: [src/parser/classes/CarouselItem.ts:8](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/CarouselItem.ts#L8)
***
@@ -52,7 +52,7 @@ Defined in: [src/parser/classes/CarouselItem.ts:8](https://github.com/LuanRT/You
> **layout\_style**: `string`
Defined in: [src/parser/classes/CarouselItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/CarouselItem.ts#L10)
Defined in: [src/parser/classes/CarouselItem.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/CarouselItem.ts#L10)
***
@@ -60,7 +60,7 @@ Defined in: [src/parser/classes/CarouselItem.ts:10](https://github.com/LuanRT/Yo
> **pagination\_thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[]
Defined in: [src/parser/classes/CarouselItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/CarouselItem.ts#L11)
Defined in: [src/parser/classes/CarouselItem.ts:11](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/CarouselItem.ts#L11)
***
@@ -68,7 +68,7 @@ Defined in: [src/parser/classes/CarouselItem.ts:11](https://github.com/LuanRT/Yo
> **paginator\_alignment**: `string`
Defined in: [src/parser/classes/CarouselItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/CarouselItem.ts#L12)
Defined in: [src/parser/classes/CarouselItem.ts:12](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/CarouselItem.ts#L12)
***
@@ -76,7 +76,7 @@ Defined in: [src/parser/classes/CarouselItem.ts:12](https://github.com/LuanRT/Yo
> `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
@@ -88,7 +88,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
> `static` **type**: `string` = `'CarouselItem'`
Defined in: [src/parser/classes/CarouselItem.ts:6](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/CarouselItem.ts#L6)
Defined in: [src/parser/classes/CarouselItem.ts:6](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/CarouselItem.ts#L6)
#### Overrides
@@ -102,7 +102,7 @@ Defined in: [src/parser/classes/CarouselItem.ts:6](https://github.com/LuanRT/You
> **get** **contents**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
Defined in: [src/parser/classes/CarouselItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/CarouselItem.ts#L24)
Defined in: [src/parser/classes/CarouselItem.ts:24](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/CarouselItem.ts#L24)
##### Returns
@@ -114,7 +114,7 @@ Defined in: [src/parser/classes/CarouselItem.ts:24](https://github.com/LuanRT/Yo
> **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.
@@ -156,7 +156,7 @@ If the node is not of the given type
> **hasKey**\<`T`, `R`\>(`key`): `this is CarouselItem & { [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.
@@ -194,7 +194,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.
@@ -232,7 +232,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.