youtubei.js / YTNodes / RichShelf
Class: RichShelf
Defined in: src/parser/classes/RichShelf.ts:6
Extends
Constructors
Constructor
new RichShelf(
data
):RichShelf
Defined in: src/parser/classes/RichShelf.ts:26
Parameters
data
Returns
RichShelf
Overrides
Properties
contents
contents:
ObservedArray
<YTNode
>
Defined in: src/parser/classes/RichShelf.ts:10
endpoint?
optional
endpoint:NavigationEndpoint
Defined in: src/parser/classes/RichShelf.ts:11
icon_type?
optional
icon_type:string
Defined in: src/parser/classes/RichShelf.ts:21
is_bottom_divider_hidden
is_bottom_divider_hidden:
boolean
Defined in: src/parser/classes/RichShelf.ts:14
is_expanded
is_expanded:
boolean
Defined in: src/parser/classes/RichShelf.ts:13
is_top_divider_hidden
is_top_divider_hidden:
boolean
Defined in: src/parser/classes/RichShelf.ts:15
layout_sizing?
optional
layout_sizing:"RICH_GRID_LAYOUT_SIZING_UNSPECIFIED"
|"RICH_GRID_LAYOUT_SIZING_STANDARD"
|"RICH_GRID_LAYOUT_SIZING_COMPACT"
|"RICH_GRID_LAYOUT_SIZING_EXTRA_COMPACT"
|"RICH_GRID_LAYOUT_SIZING_TINY"
Defined in: src/parser/classes/RichShelf.ts:16
menu
menu:
YTNode
|null
Defined in: src/parser/classes/RichShelf.ts:22
next_button
next_button:
YTNode
|null
Defined in: src/parser/classes/RichShelf.ts:23
previous_button
previous_button:
YTNode
|null
Defined in: src/parser/classes/RichShelf.ts:24
subtitle?
optional
subtitle:Text
Defined in: src/parser/classes/RichShelf.ts:12
title
title:
Text
Defined in: src/parser/classes/RichShelf.ts:9
type
readonly
type:string
Defined in: src/parser/helpers.ts:8
Inherited from
type
static
type:string
='RichShelf'
Defined in: src/parser/classes/RichShelf.ts:7
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 RichShelf & { [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 RichShelf & { [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