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

36
docs/api/youtubei.js/namespaces/YTNodes/classes/ShortsLockupView.md
View File

@@ -2,7 +2,7 @@
# Class: ShortsLockupView
Defined in: [src/parser/classes/ShortsLockupView.ts:9](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L9)
Defined in: [src/parser/classes/ShortsLockupView.ts:9](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L9)
## Extends
@@ -14,7 +14,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:9](https://github.com/LuanRT
> **new ShortsLockupView**(`data`): `ShortsLockupView`
Defined in: [src/parser/classes/ShortsLockupView.ts:26](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L26)
Defined in: [src/parser/classes/ShortsLockupView.ts:26](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L26)
#### Parameters
@@ -36,7 +36,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:26](https://github.com/LuanR
> **accessibility\_text**: `string`
Defined in: [src/parser/classes/ShortsLockupView.ts:13](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L13)
Defined in: [src/parser/classes/ShortsLockupView.ts:13](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L13)
***
@@ -44,7 +44,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:13](https://github.com/LuanR
> `optional` **badge**: [`BadgeView`](BadgeView.md) \| `null`
Defined in: [src/parser/classes/ShortsLockupView.ts:24](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L24)
Defined in: [src/parser/classes/ShortsLockupView.ts:24](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L24)
***
@@ -52,7 +52,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:24](https://github.com/LuanR
> **entity\_id**: `string`
Defined in: [src/parser/classes/ShortsLockupView.ts:12](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L12)
Defined in: [src/parser/classes/ShortsLockupView.ts:12](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L12)
***
@@ -60,7 +60,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:12](https://github.com/LuanR
> **index\_in\_collection**: `number`
Defined in: [src/parser/classes/ShortsLockupView.ts:17](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L17)
Defined in: [src/parser/classes/ShortsLockupView.ts:17](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L17)
***
@@ -68,7 +68,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:17](https://github.com/LuanR
> `optional` **inline\_player\_data**: [`NavigationEndpoint`](NavigationEndpoint.md)
Defined in: [src/parser/classes/ShortsLockupView.ts:23](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L23)
Defined in: [src/parser/classes/ShortsLockupView.ts:23](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L23)
***
@@ -76,7 +76,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:23](https://github.com/LuanR
> **menu\_on\_tap**: [`NavigationEndpoint`](NavigationEndpoint.md)
Defined in: [src/parser/classes/ShortsLockupView.ts:16](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L16)
Defined in: [src/parser/classes/ShortsLockupView.ts:16](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L16)
***
@@ -84,7 +84,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:16](https://github.com/LuanR
> **menu\_on\_tap\_a11y\_label**: `string`
Defined in: [src/parser/classes/ShortsLockupView.ts:18](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L18)
Defined in: [src/parser/classes/ShortsLockupView.ts:18](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L18)
***
@@ -92,7 +92,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:18](https://github.com/LuanR
> **on\_tap\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
Defined in: [src/parser/classes/ShortsLockupView.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L15)
Defined in: [src/parser/classes/ShortsLockupView.ts:15](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L15)
***
@@ -100,7 +100,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:15](https://github.com/LuanR
> **overlay\_metadata**: `object`
Defined in: [src/parser/classes/ShortsLockupView.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L19)
Defined in: [src/parser/classes/ShortsLockupView.ts:19](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L19)
#### primary\_text?
@@ -116,7 +116,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:19](https://github.com/LuanR
> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[]
Defined in: [src/parser/classes/ShortsLockupView.ts:14](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L14)
Defined in: [src/parser/classes/ShortsLockupView.ts:14](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L14)
***
@@ -124,7 +124,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:14](https://github.com/LuanR
> `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
@@ -136,7 +136,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
> `static` **type**: `string` = `'ShortsLockupView'`
Defined in: [src/parser/classes/ShortsLockupView.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/ShortsLockupView.ts#L10)
Defined in: [src/parser/classes/ShortsLockupView.ts:10](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/classes/ShortsLockupView.ts#L10)
#### Overrides
@@ -148,7 +148,7 @@ Defined in: [src/parser/classes/ShortsLockupView.ts:10](https://github.com/LuanR
> **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.
@@ -190,7 +190,7 @@ If the node is not of the given type
> **hasKey**\<`T`, `R`\>(`key`): `this is ShortsLockupView & { [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.
@@ -228,7 +228,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.
@@ -266,7 +266,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.