mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-13 09:32:12 +00:00
232 lines
5.2 KiB
Markdown
232 lines
5.2 KiB
Markdown
[youtubei.js](../README.md) / ShowMiniplayerCommand
|
|
|
|
# Class: ShowMiniplayerCommand
|
|
|
|
Defined in: [src/parser/continuations.ts:35](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/continuations.ts#L35)
|
|
|
|
## Extends
|
|
|
|
- [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)
|
|
|
|
## Constructors
|
|
|
|
### Constructor
|
|
|
|
> **new ShowMiniplayerCommand**(`data`): `ShowMiniplayerCommand`
|
|
|
|
Defined in: [src/parser/continuations.ts:41](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/continuations.ts#L41)
|
|
|
|
#### Parameters
|
|
|
|
##### data
|
|
|
|
[`RawNode`](../type-aliases/RawNode.md)
|
|
|
|
#### Returns
|
|
|
|
`ShowMiniplayerCommand`
|
|
|
|
#### Overrides
|
|
|
|
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`constructor`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#constructor)
|
|
|
|
## Properties
|
|
|
|
### miniplayer\_command
|
|
|
|
> **miniplayer\_command**: [`NavigationEndpoint`](../youtubei.js/namespaces/YTNodes/classes/NavigationEndpoint.md)
|
|
|
|
Defined in: [src/parser/continuations.ts:38](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/continuations.ts#L38)
|
|
|
|
***
|
|
|
|
### show\_premium\_branding
|
|
|
|
> **show\_premium\_branding**: `boolean`
|
|
|
|
Defined in: [src/parser/continuations.ts:39](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/continuations.ts#L39)
|
|
|
|
***
|
|
|
|
### type
|
|
|
|
> `readonly` **type**: `string`
|
|
|
|
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/helpers.ts#L8)
|
|
|
|
#### Inherited from
|
|
|
|
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type)
|
|
|
|
***
|
|
|
|
### type
|
|
|
|
> `readonly` `static` **type**: `"showMiniplayerCommand"` = `'showMiniplayerCommand'`
|
|
|
|
Defined in: [src/parser/continuations.ts:36](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/continuations.ts#L36)
|
|
|
|
#### Overrides
|
|
|
|
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`type`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#type-1)
|
|
|
|
## Methods
|
|
|
|
### as()
|
|
|
|
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
|
|
|
|
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/helpers.ts#L29)
|
|
|
|
Cast to one of the given types.
|
|
|
|
#### Type Parameters
|
|
|
|
##### T
|
|
|
|
`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)
|
|
|
|
##### K
|
|
|
|
`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
|
|
|
|
#### Parameters
|
|
|
|
##### types
|
|
|
|
...`K`
|
|
|
|
The types to cast to
|
|
|
|
#### Returns
|
|
|
|
`InstanceType`\<`K`\[`number`\]\>
|
|
|
|
The node cast to one of the given types
|
|
|
|
#### Throws
|
|
|
|
If the node is not of the given type
|
|
|
|
#### Inherited from
|
|
|
|
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`as`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#as)
|
|
|
|
***
|
|
|
|
### hasKey()
|
|
|
|
> **hasKey**\<`T`, `R`\>(`key`): `this is ShowMiniplayerCommand & { [k in string]: R }`
|
|
|
|
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/helpers.ts#L41)
|
|
|
|
Check for a key without asserting the type.
|
|
|
|
#### Type Parameters
|
|
|
|
##### T
|
|
|
|
`T` *extends* `string`
|
|
|
|
##### R
|
|
|
|
`R` = `any`
|
|
|
|
#### Parameters
|
|
|
|
##### key
|
|
|
|
`T`
|
|
|
|
The key to check
|
|
|
|
#### Returns
|
|
|
|
`this is ShowMiniplayerCommand & { [k in string]: R }`
|
|
|
|
Whether the node has the key
|
|
|
|
#### Inherited from
|
|
|
|
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`hasKey`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#haskey)
|
|
|
|
***
|
|
|
|
### is()
|
|
|
|
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
|
|
|
|
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/helpers.ts#L19)
|
|
|
|
Check if the node is of the given type.
|
|
|
|
#### Type Parameters
|
|
|
|
##### T
|
|
|
|
`T` *extends* [`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md)
|
|
|
|
##### K
|
|
|
|
`K` *extends* [`YTNodeConstructor`](../youtubei.js/namespaces/Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
|
|
|
|
#### Parameters
|
|
|
|
##### types
|
|
|
|
...`K`
|
|
|
|
The type to check
|
|
|
|
#### Returns
|
|
|
|
`this is InstanceType<K[number]>`
|
|
|
|
whether the node is of the given type
|
|
|
|
#### Inherited from
|
|
|
|
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`is`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#is)
|
|
|
|
***
|
|
|
|
### key()
|
|
|
|
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md)
|
|
|
|
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/helpers.ts#L51)
|
|
|
|
Assert that the node has the given key and return it.
|
|
|
|
#### Type Parameters
|
|
|
|
##### T
|
|
|
|
`T` *extends* `string`
|
|
|
|
##### R
|
|
|
|
`R` = `any`
|
|
|
|
#### Parameters
|
|
|
|
##### key
|
|
|
|
`T`
|
|
|
|
The key to check
|
|
|
|
#### Returns
|
|
|
|
[`Maybe`](../youtubei.js/namespaces/Helpers/classes/Maybe.md)
|
|
|
|
The value of the key wrapped in a Maybe
|
|
|
|
#### Throws
|
|
|
|
If the node does not have the key
|
|
|
|
#### Inherited from
|
|
|
|
[`YTNode`](../youtubei.js/namespaces/Helpers/classes/YTNode.md).[`key`](../youtubei.js/namespaces/Helpers/classes/YTNode.md#key)
|