youtubei.js / YTNodes / StructuredDescriptionPlaylistLockup

Class: StructuredDescriptionPlaylistLockup

Extends

YTNode

Constructors

new StructuredDescriptionPlaylistLockup()

new StructuredDescriptionPlaylistLockup(data): StructuredDescriptionPlaylistLockup

Parameters

• data: RawNode

Properties

aspect_ratio

aspect_ratio: number

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:16

endpoint

endpoint: NavigationEndpoint

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:14

max_lines_short_byline_text

max_lines_short_byline_text: number

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:18

max_lines_title

max_lines_title: number

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:17

overlay_position

overlay_position: string

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:19

short_byline_text

short_byline_text: Text

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:12

thumbnail

thumbnail: Thumbnail[]

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:10

thumbnail_width

thumbnail_width: number

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:15

title

title: Text

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:11

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

video_count_short_text

video_count_short_text: Text

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:13

type

static type: string = 'StructuredDescriptionPlaylistLockup'

Overrides

YTNode.type

Defined in

src/parser/classes/StructuredDescriptionPlaylistLockup.ts:8

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 StructuredDescriptionPlaylistLockup & { [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 StructuredDescriptionPlaylistLockup & { [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