mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-07-04 12:47:04 +00:00
chore(docs): update
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: Mix
|
||||
|
||||
Defined in: [src/parser/classes/Mix.ts:4](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Mix.ts#L4)
|
||||
Defined in: [src/parser/classes/Mix.ts:4](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Mix.ts#L4)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [src/parser/classes/Mix.ts:4](https://github.com/LuanRT/YouTube.js/b
|
||||
|
||||
> **new Mix**(`data`): `Mix`
|
||||
|
||||
Defined in: [src/parser/classes/Mix.ts:7](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Mix.ts#L7)
|
||||
Defined in: [src/parser/classes/Mix.ts:7](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Mix.ts#L7)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -36,7 +36,7 @@ Defined in: [src/parser/classes/Mix.ts:7](https://github.com/LuanRT/YouTube.js/b
|
||||
|
||||
> **author**: [`Text`](../../Misc/classes/Text.md) \| [`Author`](../../Misc/classes/Author.md)
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L15)
|
||||
Defined in: [src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L15)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -48,7 +48,7 @@ Defined in: [src/parser/classes/Playlist.ts:15](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L23)
|
||||
Defined in: [src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L23)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -60,7 +60,7 @@ Defined in: [src/parser/classes/Playlist.ts:23](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L24)
|
||||
Defined in: [src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L24)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -72,7 +72,7 @@ Defined in: [src/parser/classes/Playlist.ts:24](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **first\_videos**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L20)
|
||||
Defined in: [src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L20)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -84,7 +84,7 @@ Defined in: [src/parser/classes/Playlist.ts:20](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **id**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L13)
|
||||
Defined in: [src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L13)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -96,7 +96,7 @@ Defined in: [src/parser/classes/Playlist.ts:13](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **menu**: [`YTNode`](../../Helpers/classes/YTNode.md)
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L22)
|
||||
Defined in: [src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L22)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -108,7 +108,7 @@ Defined in: [src/parser/classes/Playlist.ts:22](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **share\_url**: `string` \| `null`
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L21)
|
||||
Defined in: [src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L21)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -120,7 +120,7 @@ Defined in: [src/parser/classes/Playlist.ts:21](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L25)
|
||||
Defined in: [src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L25)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -132,7 +132,7 @@ Defined in: [src/parser/classes/Playlist.ts:25](https://github.com/LuanRT/YouTub
|
||||
|
||||
> `optional` **thumbnail\_renderer**: [`PlaylistCustomThumbnail`](PlaylistCustomThumbnail.md) \| [`PlaylistVideoThumbnail`](PlaylistVideoThumbnail.md)
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L17)
|
||||
Defined in: [src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L17)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -144,7 +144,7 @@ Defined in: [src/parser/classes/Playlist.ts:17](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[]
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L16)
|
||||
Defined in: [src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L16)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -156,7 +156,7 @@ Defined in: [src/parser/classes/Playlist.ts:16](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **title**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L14)
|
||||
Defined in: [src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L14)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -168,7 +168,7 @@ Defined in: [src/parser/classes/Playlist.ts:14](https://github.com/LuanRT/YouTub
|
||||
|
||||
> `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
|
||||
|
||||
@@ -180,7 +180,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> **video\_count**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L18)
|
||||
Defined in: [src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L18)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -192,7 +192,7 @@ Defined in: [src/parser/classes/Playlist.ts:18](https://github.com/LuanRT/YouTub
|
||||
|
||||
> **video\_count\_short**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L19)
|
||||
Defined in: [src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L19)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -204,7 +204,7 @@ Defined in: [src/parser/classes/Playlist.ts:19](https://github.com/LuanRT/YouTub
|
||||
|
||||
> `optional` **view\_playlist**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
Defined in: [src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Playlist.ts#L26)
|
||||
Defined in: [src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Playlist.ts#L26)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -216,7 +216,7 @@ Defined in: [src/parser/classes/Playlist.ts:26](https://github.com/LuanRT/YouTub
|
||||
|
||||
> `static` **type**: `string` = `'Mix'`
|
||||
|
||||
Defined in: [src/parser/classes/Mix.ts:5](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Mix.ts#L5)
|
||||
Defined in: [src/parser/classes/Mix.ts:5](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Mix.ts#L5)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -228,7 +228,7 @@ Defined in: [src/parser/classes/Mix.ts:5](https://github.com/LuanRT/YouTube.js/b
|
||||
|
||||
> **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.
|
||||
|
||||
@@ -270,7 +270,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is Mix & { [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.
|
||||
|
||||
@@ -308,7 +308,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.
|
||||
|
||||
@@ -346,7 +346,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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user