youtubei.js / YTNodes / EndscreenElement

new EndscreenElement(data): EndscreenElement

Defined in: src/parser/classes/EndscreenElement.ts:29

Parameters

data

RawNode

Returns

EndscreenElement

Overrides

YTNode.constructor

Properties

aspect_ratio

aspect_ratio: number

Defined in: src/parser/classes/EndscreenElement.ts:24

call_to_action?

optional call_to_action: Text

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

end_ms

end_ms: number

Defined in: src/parser/classes/EndscreenElement.ts:26

endpoint

endpoint: NavigationEndpoint

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

optional hovercard_button: YTNode

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

icon?

optional icon: Thumbnail[]

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

id

id: string

Defined in: src/parser/classes/EndscreenElement.ts:27

image?

optional image: Thumbnail[]

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

optional is_subscribe: boolean

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

left

left: number

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

metadata?

optional metadata: Text

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

playlist_length?

optional playlist_length: Text

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

start_ms

start_ms: number

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

style

style: string

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

thumbnail_overlays?

optional thumbnail_overlays: ObservedArray<YTNode>

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

title

title: Text

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

top

top: number

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

type

readonly type: string

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

Inherited from

YTNode.type

width

width: number

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

type

static type: string = 'EndscreenElement'

Defined in: src/parser/classes/EndscreenElement.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 EndscreenElement & { [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 EndscreenElement & { [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