YouTube.js/docs/api/namespaces/YTNodes/classes/ToggleFormField.md

youtubei.js / YTNodes / ToggleFormField

Class: ToggleFormField

Extends

• YTNode

Constructors

new ToggleFormField()

new ToggleFormField(data): ToggleFormField

Parameters

• data: RawNode

Returns

ToggleFormField

Overrides

YTNode.constructor

Defined in

src/parser/classes/ToggleFormField.ts:13

Properties

label

label: Text

Defined in

src/parser/classes/ToggleFormField.ts:8

---

toggle_off_action?

optional toggle_off_action: NavigationEndpoint

Defined in

src/parser/classes/ToggleFormField.ts:11

---

toggle_on_action?

optional toggle_on_action: NavigationEndpoint

Defined in

src/parser/classes/ToggleFormField.ts:10

---

toggled

toggled: boolean

Defined in

src/parser/classes/ToggleFormField.ts:9

---

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

---

type

static type: string = 'ToggleFormField'

Overrides

YTNode.type

Defined in

src/parser/classes/ToggleFormField.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:29

---

hasKey()

hasKey<T, R>(key): this is ToggleFormField & { [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 ToggleFormField & { [k in string]: R }

Whether the node has the key

Inherited from

YTNode.hasKey

Defined in

src/parser/helpers.ts:41

---

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:19

---

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:51