youtubei.js / YTNodes / Grid
Class: Grid
Defined in: src/parser/classes/Grid.ts:4
Extends
Constructors
Constructor
new Grid(
data):Grid
Defined in: src/parser/classes/Grid.ts:14
Parameters
data
Returns
Grid
Overrides
Properties
continuation
continuation:
string|null
Defined in: src/parser/classes/Grid.ts:11
header?
optionalheader:YTNode
Defined in: src/parser/classes/Grid.ts:12
is_collapsible?
optionalis_collapsible:boolean
Defined in: src/parser/classes/Grid.ts:8
items
items:
ObservedArray<YTNode>
Defined in: src/parser/classes/Grid.ts:7
target_id?
optionaltarget_id:string
Defined in: src/parser/classes/Grid.ts:10
type
readonlytype:string
Defined in: src/parser/helpers.ts:8
Inherited from
visible_row_count?
optionalvisible_row_count:string
Defined in: src/parser/classes/Grid.ts:9
type
statictype:string='Grid'
Defined in: src/parser/classes/Grid.ts:5
Overrides
Accessors
contents
Get Signature
get contents():
ObservedArray<YTNode>
Defined in: src/parser/classes/Grid.ts:39
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 Grid & { [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 Grid & { [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