youtubei.js / YTNodes / MusicCarouselShelf
Class: MusicCarouselShelf
Defined in: src/parser/classes/MusicCarouselShelf.ts:10
Extends
Constructors
Constructor
new MusicCarouselShelf(
data):MusicCarouselShelf
Defined in: src/parser/classes/MusicCarouselShelf.ts:17
Parameters
data
Returns
MusicCarouselShelf
Overrides
Properties
contents
contents:
ObservedArray<MusicMultiRowListItem|MusicNavigationButton|MusicResponsiveListItem|MusicTwoRowItem>
Defined in: src/parser/classes/MusicCarouselShelf.ts:14
header
header:
MusicCarouselShelfBasicHeader|null
Defined in: src/parser/classes/MusicCarouselShelf.ts:13
num_items_per_column?
optionalnum_items_per_column:number
Defined in: src/parser/classes/MusicCarouselShelf.ts:15
type
readonlytype:string
Defined in: src/parser/helpers.ts:8
Inherited from
type
statictype:string='MusicCarouselShelf'
Defined in: src/parser/classes/MusicCarouselShelf.ts:11
Overrides
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
hasKey()
hasKey<
T,R>(key):this is MusicCarouselShelf & { [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 MusicCarouselShelf & { [k in string]: R }
Whether the node has the key
Inherited from
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
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
The value of the key wrapped in a Maybe
Throws
If the node does not have the key