jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-07-04 12:47:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Regen API ref

Browse Source
This commit is contained in:
LuanRT
2026-05-12 23:01:15 -03:00
parent 853a36307b
commit 0a82c8bd99
857 changed files with 8999 additions and 8813 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/api/youtubei.js/namespaces/YTNodes/classes/PlayerOverlay.md
View File

@@ -2,7 +2,7 @@
# Class: PlayerOverlay
Defined in: [src/parser/classes/PlayerOverlay.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L10)
Defined in: [src/parser/classes/PlayerOverlay.ts:10](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L10)
## Extends
@@ -14,7 +14,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:10](https://github.com/LuanRT/Y
> **new PlayerOverlay**(`data`): `PlayerOverlay`
Defined in: [src/parser/classes/PlayerOverlay.ts:23](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L23)
Defined in: [src/parser/classes/PlayerOverlay.ts:23](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L23)
#### Parameters
@@ -36,7 +36,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:23](https://github.com/LuanRT/Y
> **actions**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
Defined in: [src/parser/classes/PlayerOverlay.ts:18](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L18)
Defined in: [src/parser/classes/PlayerOverlay.ts:18](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L18)
***
@@ -44,7 +44,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:18](https://github.com/LuanRT/Y
> **add\_to\_menu**: [`Menu`](Menu.md) \| `null`
Defined in: [src/parser/classes/PlayerOverlay.ts:16](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L16)
Defined in: [src/parser/classes/PlayerOverlay.ts:16](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L16)
***
@@ -52,7 +52,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:16](https://github.com/LuanRT/Y
> **autoplay**: [`PlayerOverlayAutoplay`](PlayerOverlayAutoplay.md) \| `null`
Defined in: [src/parser/classes/PlayerOverlay.ts:14](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L14)
Defined in: [src/parser/classes/PlayerOverlay.ts:14](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L14)
***
@@ -60,7 +60,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:14](https://github.com/LuanRT/Y
> **browser\_media\_session**: [`YTNode`](../../Helpers/classes/YTNode.md) \| `null`
Defined in: [src/parser/classes/PlayerOverlay.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L19)
Defined in: [src/parser/classes/PlayerOverlay.ts:19](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L19)
***
@@ -68,7 +68,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:19](https://github.com/LuanRT/Y
> **decorated\_player\_bar**: [`DecoratedPlayerBar`](DecoratedPlayerBar.md) \| `null`
Defined in: [src/parser/classes/PlayerOverlay.ts:20](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L20)
Defined in: [src/parser/classes/PlayerOverlay.ts:20](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L20)
***
@@ -76,7 +76,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:20](https://github.com/LuanRT/Y
> **end\_screen**: [`WatchNextEndScreen`](WatchNextEndScreen.md) \| `null`
Defined in: [src/parser/classes/PlayerOverlay.ts:13](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L13)
Defined in: [src/parser/classes/PlayerOverlay.ts:13](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L13)
***
@@ -84,7 +84,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:13](https://github.com/LuanRT/Y
> **fullscreen\_engagement**: [`YTNode`](../../Helpers/classes/YTNode.md) \| `null`
Defined in: [src/parser/classes/PlayerOverlay.ts:17](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L17)
Defined in: [src/parser/classes/PlayerOverlay.ts:17](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L17)
***
@@ -92,7 +92,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:17](https://github.com/LuanRT/Y
> **share\_button**: [`Button`](Button.md) \| `null`
Defined in: [src/parser/classes/PlayerOverlay.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L15)
Defined in: [src/parser/classes/PlayerOverlay.ts:15](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L15)
***
@@ -100,7 +100,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:15](https://github.com/LuanRT/Y
> `readonly` **type**: `string`
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L8)
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/helpers.ts#L8)
#### Inherited from
@@ -112,7 +112,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
> **video\_details**: [`PlayerOverlayVideoDetails`](PlayerOverlayVideoDetails.md) \| `null`
Defined in: [src/parser/classes/PlayerOverlay.ts:21](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L21)
Defined in: [src/parser/classes/PlayerOverlay.ts:21](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L21)
***
@@ -120,7 +120,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:21](https://github.com/LuanRT/Y
> `static` **type**: `string` = `'PlayerOverlay'`
Defined in: [src/parser/classes/PlayerOverlay.ts:11](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/PlayerOverlay.ts#L11)
Defined in: [src/parser/classes/PlayerOverlay.ts:11](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/PlayerOverlay.ts#L11)
#### Overrides
@@ -132,7 +132,7 @@ Defined in: [src/parser/classes/PlayerOverlay.ts:11](https://github.com/LuanRT/Y
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L29)
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.
@@ -174,7 +174,7 @@ If the node is not of the given type
> **hasKey**\<`T`, `R`\>(`key`): `this is PlayerOverlay & { [k in string]: R }`
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L41)
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.
@@ -212,7 +212,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/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L19)
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.
@@ -250,7 +250,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/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L51)
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.