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