youtubei.js / YTNodes / ToggleButton

new ToggleButton(data): ToggleButton

Defined in: src/parser/classes/ToggleButton.ts:23

Parameters

data

RawNode

Returns

ToggleButton

Overrides

YTNode.constructor

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

Defined in: src/parser/classes/ToggleButton.ts:12

tooltip: string

Defined in: src/parser/classes/ToggleButton.ts:11

type

readonly type: string

Defined in: src/parser/helpers.ts:8

Inherited from

YTNode.type

type

static type: string = 'ToggleButton'

Defined in: src/parser/classes/ToggleButton.ts:7

Overrides

YTNode.type

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

YTNode.as

hasKey()

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

Whether the node has the key

Inherited from

YTNode.hasKey

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

YTNode.is

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

Maybe

The value of the key wrapped in a Maybe

Throws

If the node does not have the key

Inherited from

YTNode.key