youtubei.js / YTNodes / ShortsLockupView

Class: ShortsLockupView

Extends

YTNode

Constructors

new ShortsLockupView()

new ShortsLockupView(data): ShortsLockupView

Parameters

• data: RawNode

Properties

accessibility_text

accessibility_text: string

Defined in

src/parser/classes/ShortsLockupView.ts:13

badge?

optional badge: null | BadgeView

Defined in

src/parser/classes/ShortsLockupView.ts:24

entity_id

entity_id: string

Defined in

src/parser/classes/ShortsLockupView.ts:12

index_in_collection

index_in_collection: number

Defined in

src/parser/classes/ShortsLockupView.ts:17

inline_player_data?

optional inline_player_data: NavigationEndpoint

Defined in

src/parser/classes/ShortsLockupView.ts:23

menu_on_tap: NavigationEndpoint

Defined in

src/parser/classes/ShortsLockupView.ts:16

menu_on_tap_a11y_label: string

Defined in

src/parser/classes/ShortsLockupView.ts:18

on_tap_endpoint

on_tap_endpoint: NavigationEndpoint

Defined in

src/parser/classes/ShortsLockupView.ts:15

overlay_metadata

overlay_metadata: object

primary_text?

optional primary_text: Text

secondary_text?

optional secondary_text: Text

Defined in

src/parser/classes/ShortsLockupView.ts:19

thumbnail

thumbnail: Thumbnail[]

Defined in

src/parser/classes/ShortsLockupView.ts:14

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

type

static type: string = 'ShortsLockupView'

Overrides

YTNode.type

Defined in

src/parser/classes/ShortsLockupView.ts:10

Methods

as()

as<T, K>(...types): InstanceType<K[number]>

Cast to one of the given types.

Type Parameters

• T extends YTNode

• K extends YTNodeConstructor<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.as

Defined in

src/parser/helpers.ts:38

hasKey()

hasKey<T, R>(key): this is ShortsLockupView & { [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 ShortsLockupView & { [k in string]: R }

Whether the node has the key

Inherited from

YTNode.hasKey

Defined in

src/parser/helpers.ts:50

is()

is<T, K>(...types): this is InstanceType<K[number]>

Check if the node is of the given type.

Type Parameters

• T extends YTNode

• K extends YTNodeConstructor<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.is

Defined in

src/parser/helpers.ts:28

key()

key<T, R>(key): Maybe

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

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

YTNode.key

Defined in

src/parser/helpers.ts:60