youtubei.js / YTNodes / SettingsCheckbox
Class: SettingsCheckbox
Defined in: src/parser/classes/SettingsCheckbox.ts:5
Extends
Constructors
Constructor
new SettingsCheckbox(
data):SettingsCheckbox
Defined in: src/parser/classes/SettingsCheckbox.ts:14
Parameters
data
Returns
SettingsCheckbox
Overrides
Properties
disabled
disabled:
boolean
Defined in: src/parser/classes/SettingsCheckbox.ts:11
enabled
enabled:
boolean
Defined in: src/parser/classes/SettingsCheckbox.ts:10
help_text
help_text:
Text
Defined in: src/parser/classes/SettingsCheckbox.ts:9
id
id:
string
Defined in: src/parser/classes/SettingsCheckbox.ts:12
title
title:
Text
Defined in: src/parser/classes/SettingsCheckbox.ts:8
type
readonlytype:string
Defined in: src/parser/helpers.ts:8
Inherited from
type
statictype:string='SettingsCheckbox'
Defined in: src/parser/classes/SettingsCheckbox.ts:6
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 SettingsCheckbox & { [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 SettingsCheckbox & { [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