youtubei.js / YTNodes / SettingsCheckbox

Class: SettingsCheckbox

Extends

YTNode

Constructors

new SettingsCheckbox()

new SettingsCheckbox(data): SettingsCheckbox

Parameters

• data: RawNode

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

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

type

static type: string = 'SettingsCheckbox'

Overrides

YTNode.type

Defined in

src/parser/classes/SettingsCheckbox.ts:6

Methods

as()

as<T, K>(...types): InstanceType<K[number]>

Cast to one of the given types.

Type Parameters

• T extends YTNode

• 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

YTNode.as

Defined in

src/parser/helpers.ts:38

hasKey()

hasKey<T, R>(key): this is SettingsCheckbox & { [k in string]: R }

Check for a key without asserting the type.

Type Parameters

• T extends string

• 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

YTNode.hasKey

Defined in

src/parser/helpers.ts:50

is()

is<T, K>(...types): this is InstanceType<K[number]>

Check if the node is of the given type.

Type Parameters

• T extends YTNode

• 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

YTNode.is

Defined in

src/parser/helpers.ts:28

key()

key<T, R>(key): Maybe

Assert that the node has the given key and return it.

Type Parameters

• T extends string

• R = any

Parameters

• key: T

The key to check

Returns

Maybe

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

YTNode.key

Defined in

src/parser/helpers.ts:60