youtubei.js / YTNodes / VerticalList
Class: VerticalList
Defined in: src/parser/classes/VerticalList.ts:5
Extends
Constructors
Constructor
new VerticalList(
data
):VerticalList
Defined in: src/parser/classes/VerticalList.ts:12
Parameters
data
Returns
VerticalList
Overrides
Properties
collapsed_item_count
collapsed_item_count:
string
Defined in: src/parser/classes/VerticalList.ts:9
collapsed_state_button_text
collapsed_state_button_text:
Text
Defined in: src/parser/classes/VerticalList.ts:10
items
items:
ObservedArray
<YTNode
>
Defined in: src/parser/classes/VerticalList.ts:8
type
readonly
type:string
Defined in: src/parser/helpers.ts:8
Inherited from
type
static
type:string
='VerticalList'
Defined in: src/parser/classes/VerticalList.ts:6
Overrides
Accessors
contents
Get Signature
get contents():
ObservedArray
<YTNode
>
Defined in: src/parser/classes/VerticalList.ts:20
Returns
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 VerticalList & { [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 VerticalList & { [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