YouTube.js/docs/api/namespaces/YTNodes/classes/MusicCardShelf.md

youtubei.js / YTNodes / MusicCardShelf

Class: MusicCardShelf

Extends

• YTNode

Constructors

new MusicCardShelf()

new MusicCardShelf(data): MusicCardShelf

Parameters

• data: RawNode

Returns

MusicCardShelf

Overrides

YTNode.constructor

Defined in

src/parser/classes/MusicCardShelf.ts:27

Properties

buttons

buttons: ObservedArray<Button>

Defined in

src/parser/classes/MusicCardShelf.ts:18

---

contents?

optional contents: ObservedArray<YTNode>

Defined in

src/parser/classes/MusicCardShelf.ts:25

---

end_icon_type?

optional end_icon_type: string

Defined in

src/parser/classes/MusicCardShelf.ts:22

---

header

header: null | MusicCardShelfHeaderBasic

Defined in

src/parser/classes/MusicCardShelf.ts:21

---

menu

menu: null | Menu

Defined in

src/parser/classes/MusicCardShelf.ts:19

---

on_tap

on_tap: NavigationEndpoint

Defined in

src/parser/classes/MusicCardShelf.ts:20

---

subtitle

subtitle: Text

Defined in

src/parser/classes/MusicCardShelf.ts:17

---

subtitle_badges

subtitle_badges: ObservedArray<MusicInlineBadge>

Defined in

src/parser/classes/MusicCardShelf.ts:23

---

thumbnail

thumbnail: null | MusicThumbnail

Defined in

src/parser/classes/MusicCardShelf.ts:15

---

thumbnail_overlay

thumbnail_overlay: null | MusicItemThumbnailOverlay

Defined in

src/parser/classes/MusicCardShelf.ts:24

---

title

title: Text

Defined in

src/parser/classes/MusicCardShelf.ts:16

---

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

---

type

static type: string = 'MusicCardShelf'

Overrides

YTNode.type

Defined in

src/parser/classes/MusicCardShelf.ts:13

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