youtubei.js / YTNodes / Button
Class: Button
Defined in: src/parser/classes/Button.ts:7
Extends
Extended by
Constructors
Constructor
new Button(
data):Button
Defined in: src/parser/classes/Button.ts:21
Parameters
data
Returns
Button
Overrides
Properties
accessibility?
optionalaccessibility:AccessibilitySupportedDatas
Defined in: src/parser/classes/Button.ts:19
endpoint
endpoint:
NavigationEndpoint
Defined in: src/parser/classes/Button.ts:18
icon_type?
optionalicon_type:string
Defined in: src/parser/classes/Button.ts:15
is_disabled?
optionalis_disabled:boolean
Defined in: src/parser/classes/Button.ts:16
label?
optionallabel:string
Defined in: src/parser/classes/Button.ts:11
size?
optionalsize:string
Defined in: src/parser/classes/Button.ts:14
style?
optionalstyle:string
Defined in: src/parser/classes/Button.ts:13
target_id?
optionaltarget_id:string
Defined in: src/parser/classes/Button.ts:17
text?
optionaltext:string
Defined in: src/parser/classes/Button.ts:10
tooltip?
optionaltooltip:string
Defined in: src/parser/classes/Button.ts:12
type
readonlytype:string
Defined in: src/parser/helpers.ts:8
Inherited from
type
statictype:string='Button'
Defined in: src/parser/classes/Button.ts:8
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 Button & { [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 Button & { [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