youtubei.js / YTNodes / SubscribeButton

Class: SubscribeButton

Extends

YTNode

Constructors

new SubscribeButton()

new SubscribeButton(data): SubscribeButton

Parameters

• data: RawNode

Properties

button_text

button_text: Text

Defined in

src/parser/classes/SubscribeButton.ts:10

channel_id

channel_id: string

Defined in

src/parser/classes/SubscribeButton.ts:14

enabled

enabled: boolean

Defined in

src/parser/classes/SubscribeButton.ts:12

item_type

item_type: string

Defined in

src/parser/classes/SubscribeButton.ts:13

notification_preference_button

notification_preference_button: null | SubscriptionNotificationToggleButton

Defined in

src/parser/classes/SubscribeButton.ts:18

optional on_subscribe_endpoints: NavigationEndpoint[]

Defined in

src/parser/classes/SubscribeButton.ts:20

on_unsubscribe_endpoints?

optional on_unsubscribe_endpoints: NavigationEndpoint[]

Defined in

src/parser/classes/SubscribeButton.ts:21

service_endpoints?

optional service_endpoints: NavigationEndpoint[]

Defined in

src/parser/classes/SubscribeButton.ts:19

show_preferences

show_preferences: boolean

Defined in

src/parser/classes/SubscribeButton.ts:15

optional subscribe_accessibility_label: string

Defined in

src/parser/classes/SubscribeButton.ts:24

subscribed

subscribed: boolean

Defined in

src/parser/classes/SubscribeButton.ts:11

subscribed_entity_key?

optional subscribed_entity_key: string

Defined in

src/parser/classes/SubscribeButton.ts:22

subscribed_text

subscribed_text: Text

Defined in

src/parser/classes/SubscribeButton.ts:16

target_id?

optional target_id: string

Defined in

src/parser/classes/SubscribeButton.ts:23

type

readonly type: string

Inherited from

YTNode.type

Defined in

src/parser/helpers.ts:8

unsubscribe_accessibility_label?

optional unsubscribe_accessibility_label: string

Defined in

src/parser/classes/SubscribeButton.ts:25

unsubscribed_text

unsubscribed_text: Text

Defined in

src/parser/classes/SubscribeButton.ts:17

type

static type: string = 'SubscribeButton'

Overrides

YTNode.type

Defined in

src/parser/classes/SubscribeButton.ts:8

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 SubscribeButton & { [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 SubscribeButton & { [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