youtubei.js / YTNodes / StructuredDescriptionVideoLockup

new StructuredDescriptionVideoLockup(data): StructuredDescriptionVideoLockup

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:25

Parameters

data

RawNode

Returns

StructuredDescriptionVideoLockup

Overrides

YTNode.constructor

Properties

aspect_ratio?

optional aspect_ratio?: number

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:22

disable_navigation_endpoint: boolean

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:17

endpoint

endpoint: NavigationEndpoint

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:14

is_live_video

is_live_video: boolean

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:16

length_text?

optional length_text?: Text

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:15

max_lines_metadata_details?

optional max_lines_metadata_details?: number

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:20

max_lines_short_byline_text?

optional max_lines_short_byline_text?: number

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:19

max_lines_title?

optional max_lines_title?: number

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:18

metadata_details?

optional metadata_details?: Text

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:13

short_byline_text?

optional short_byline_text?: Text

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:12

thumbnail

thumbnail: Thumbnail[]

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:10

thumbnail_overlays

thumbnail_overlays: ObservedArray<YTNode>

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:23

thumbnail_width?

optional thumbnail_width?: number

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:21

title

title: Text

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:11

type

readonly type: string

Defined in: src/parser/helpers.ts:8

Inherited from

YTNode.type

type

static type: string = 'StructuredDescriptionVideoLockup'

Defined in: src/parser/classes/StructuredDescriptionVideoLockup.ts:8

Overrides

YTNode.type

Methods

as()

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

Defined in: src/parser/helpers.ts:29

Cast to one of the given types.

Type Parameters

T

T extends YTNode

K

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

hasKey()

hasKey<T, R>(key): this is StructuredDescriptionVideoLockup & { [k in string]: R }

Defined in: src/parser/helpers.ts:41

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 StructuredDescriptionVideoLockup & { [k in string]: R }

Whether the node has the key

Inherited from

YTNode.hasKey

is()

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

Defined in: src/parser/helpers.ts:19

Check if the node is of the given type.

Type Parameters

T

T extends YTNode

K

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

key()

key<T, R>(key): Maybe

Defined in: src/parser/helpers.ts:51

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

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

YTNode.key