mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-23 23:09:28 +00:00
chore: add proper documentation (#763)
* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
This commit is contained in:
Luan
323
docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md
Normal file
323
docs/api/namespaces/YTNodes/classes/PlayerOverlayAutoplay.md
Normal file
@@ -0,0 +1,323 @@
|
||||
[youtubei.js](../../../README.md) / [YTNodes](../README.md) / PlayerOverlayAutoplay
|
||||
|
||||
# Class: PlayerOverlayAutoplay
|
||||
|
||||
## Extends
|
||||
|
||||
- [`YTNode`](../../Helpers/classes/YTNode.md)
|
||||
|
||||
## Constructors
|
||||
|
||||
### new PlayerOverlayAutoplay()
|
||||
|
||||
> **new PlayerOverlayAutoplay**(`data`): [`PlayerOverlayAutoplay`](PlayerOverlayAutoplay.md)
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`PlayerOverlayAutoplay`](PlayerOverlayAutoplay.md)
|
||||
|
||||
#### Overrides
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:28](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L28)
|
||||
|
||||
## Properties
|
||||
|
||||
### author
|
||||
|
||||
> **author**: [`Author`](../../Misc/classes/Author.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:23](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L23)
|
||||
|
||||
***
|
||||
|
||||
### background
|
||||
|
||||
> **background**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[]
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:21](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L21)
|
||||
|
||||
***
|
||||
|
||||
### cancel\_button
|
||||
|
||||
> **cancel\_button**: `null` \| [`Button`](Button.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:24](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L24)
|
||||
|
||||
***
|
||||
|
||||
### close\_button
|
||||
|
||||
> **close\_button**: `null` \| [`Button`](Button.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:26](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L26)
|
||||
|
||||
***
|
||||
|
||||
### count\_down\_secs\_for\_fullscreen
|
||||
|
||||
> **count\_down\_secs\_for\_fullscreen**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:18](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L18)
|
||||
|
||||
***
|
||||
|
||||
### next\_button
|
||||
|
||||
> **next\_button**: `null` \| [`Button`](Button.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:25](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L25)
|
||||
|
||||
***
|
||||
|
||||
### prefer\_immediate\_redirect
|
||||
|
||||
> **prefer\_immediate\_redirect**: `any`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:17](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L17)
|
||||
|
||||
***
|
||||
|
||||
### published
|
||||
|
||||
> **published**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:20](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L20)
|
||||
|
||||
***
|
||||
|
||||
### short\_view\_count
|
||||
|
||||
> **short\_view\_count**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:14](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L14)
|
||||
|
||||
***
|
||||
|
||||
### thumbnail\_overlays
|
||||
|
||||
> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:22](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L22)
|
||||
|
||||
***
|
||||
|
||||
### title
|
||||
|
||||
> **title**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:11](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L11)
|
||||
|
||||
***
|
||||
|
||||
### type
|
||||
|
||||
> `readonly` **type**: `string`
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L8)
|
||||
|
||||
***
|
||||
|
||||
### video\_id
|
||||
|
||||
> **video\_id**: `string`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:12](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L12)
|
||||
|
||||
***
|
||||
|
||||
### video\_title
|
||||
|
||||
> **video\_title**: [`Text`](../../Misc/classes/Text.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:13](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L13)
|
||||
|
||||
***
|
||||
|
||||
### type
|
||||
|
||||
> `static` **type**: `string` = `'PlayerOverlayAutoplay'`
|
||||
|
||||
#### Overrides
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/classes/PlayerOverlayAutoplay.ts:9](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/PlayerOverlayAutoplay.ts#L9)
|
||||
|
||||
## Methods
|
||||
|
||||
### as()
|
||||
|
||||
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
|
||||
|
||||
Cast to one of the given types.
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
|
||||
|
||||
• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
|
||||
|
||||
#### Parameters
|
||||
|
||||
• ...**types**: `K`
|
||||
|
||||
#### Returns
|
||||
|
||||
`InstanceType`\<`K`\[`number`\]\>
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L35)
|
||||
|
||||
***
|
||||
|
||||
### hasKey()
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerOverlayAutoplay & { [k in string]: R }`
|
||||
|
||||
Check for a key without asserting the type.
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
• **T** *extends* `string`
|
||||
|
||||
• **R** = `any`
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **key**: `T`
|
||||
|
||||
The key to check
|
||||
|
||||
#### Returns
|
||||
|
||||
`this is PlayerOverlayAutoplay & { [k in string]: R }`
|
||||
|
||||
Whether the node has the key
|
||||
|
||||
#### Inherited from
|
||||
|
||||
[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L47)
|
||||
|
||||
***
|
||||
|
||||
### is()
|
||||
|
||||
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
|
||||
|
||||
Check if the node is of the given type.
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
|
||||
|
||||
• **K** *extends* [`YTNodeConstructor`](../../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`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L28)
|
||||
|
||||
***
|
||||
|
||||
### key()
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md)
|
||||
|
||||
Assert that the node has the given key and return it.
|
||||
|
||||
#### Type Parameters
|
||||
|
||||
• **T** *extends* `string`
|
||||
|
||||
• **R** = `any`
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **key**: `T`
|
||||
|
||||
The key to check
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Maybe`](../../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`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L57)
|
||||
Reference in New Issue
Block a user