youtubei.js / YTNodes / ToggleButton

Class: ToggleButton

Extends

• YTNode

Constructors

new ToggleButton()

new ToggleButton(data): ToggleButton

Parameters

• data: RawNode

Returns

ToggleButton

Overrides

YTNode.constructor

Defined in

src/parser/classes/ToggleButton.ts:23

Properties

button_id?

optional button_id: string

Defined in

src/parser/classes/ToggleButton.ts:20

---

endpoint

endpoint: NavigationEndpoint

Defined in

src/parser/classes/ToggleButton.ts:18

---

icon_type

icon_type: string

Defined in

src/parser/classes/ToggleButton.ts:15

---

is_disabled

is_disabled: boolean

Defined in

src/parser/classes/ToggleButton.ts:14

---

is_toggled

is_toggled: boolean

Defined in

src/parser/classes/ToggleButton.ts:13

---

like_count?

optional like_count: number

Defined in

src/parser/classes/ToggleButton.ts:16

---

short_like_count?

optional short_like_count: string

Defined in

src/parser/classes/ToggleButton.ts:17

---

target_id?

optional target_id: string

Defined in

src/parser/classes/ToggleButton.ts:21

---

text

text: Text

Defined in

src/parser/classes/ToggleButton.ts:9

---

toggled_endpoint

toggled_endpoint: NavigationEndpoint

Defined in

src/parser/classes/ToggleButton.ts:19

---

toggled_text

toggled_text: Text

Defined in

src/parser/classes/ToggleButton.ts:10

---

toggled_tooltip

toggled_tooltip: string

Defined in

src/parser/classes/ToggleButton.ts:12

---

tooltip

tooltip: string

Defined in

src/parser/classes/ToggleButton.ts:11

---

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

---

type

static type: string = 'ToggleButton'

Overrides

YTNode.type

Defined in

src/parser/classes/ToggleButton.ts:7

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

Returns

InstanceType<K[number]>

Inherited from

YTNode.as

Defined in

src/parser/helpers.ts:35

---

hasKey()

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

Whether the node has the key

Inherited from

YTNode.hasKey

Defined in

src/parser/helpers.ts:47

---

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