youtubei.js / YTNodes / BackgroundPromo

new BackgroundPromo(data): BackgroundPromo

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

Parameters

data

RawNode

Returns

BackgroundPromo

Overrides

YTNode.constructor

Properties

body_text?

optional body_text: Text

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

cta_button?

optional cta_button: Button | ButtonView | null

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

icon_type?

optional icon_type: string

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

title?

optional title: Text

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

type

readonly type: string

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

Inherited from

YTNode.type

type

static type: string = 'BackgroundPromo'

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