jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-16 19:12:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Update API ref

Browse Source
This commit is contained in:
Luan
2024-11-22 04:25:16 -03:00
parent fc5571629e
commit 4e9d64404e
927 changed files with 26023 additions and 9839 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
docs/api/namespaces/YTNodes/classes/SubscribeButton.md
View File

@@ -26,17 +26,27 @@
#### Defined in
[src/parser/classes/SubscribeButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L21)
[src/parser/classes/SubscribeButton.ts:27](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L27)
## Properties
### button\_text
> **button\_text**: [`Text`](../../Misc/classes/Text.md)
#### Defined in
[src/parser/classes/SubscribeButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L10)
***
### channel\_id
> **channel\_id**: `string`
#### Defined in
[src/parser/classes/SubscribeButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L14)
[src/parser/classes/SubscribeButton.ts:14](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L14)
***
@@ -46,17 +56,7 @@
#### Defined in
[src/parser/classes/SubscribeButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L12)
***
### endpoint
> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
#### Defined in
[src/parser/classes/SubscribeButton.ts:19](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L19)
[src/parser/classes/SubscribeButton.ts:12](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L12)
***
@@ -66,7 +66,7 @@
#### Defined in
[src/parser/classes/SubscribeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L13)
[src/parser/classes/SubscribeButton.ts:13](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L13)
***
@@ -76,7 +76,37 @@
#### Defined in
[src/parser/classes/SubscribeButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L18)
[src/parser/classes/SubscribeButton.ts:18](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L18)
***
### on\_subscribe\_endpoints?
> `optional` **on\_subscribe\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[]
#### Defined in
[src/parser/classes/SubscribeButton.ts:20](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L20)
***
### on\_unsubscribe\_endpoints?
> `optional` **on\_unsubscribe\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[]
#### Defined in
[src/parser/classes/SubscribeButton.ts:21](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L21)
***
### service\_endpoints?
> `optional` **service\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[]
#### Defined in
[src/parser/classes/SubscribeButton.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L19)
***
@@ -86,7 +116,17 @@
#### Defined in
[src/parser/classes/SubscribeButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L15)
[src/parser/classes/SubscribeButton.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L15)
***
### subscribe\_accessibility\_label?
> `optional` **subscribe\_accessibility\_label**: `string`
#### Defined in
[src/parser/classes/SubscribeButton.ts:24](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L24)
***
@@ -96,7 +136,17 @@
#### Defined in
[src/parser/classes/SubscribeButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L11)
[src/parser/classes/SubscribeButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L11)
***
### subscribed\_entity\_key?
> `optional` **subscribed\_entity\_key**: `string`
#### Defined in
[src/parser/classes/SubscribeButton.ts:22](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L22)
***
@@ -106,17 +156,17 @@
#### Defined in
[src/parser/classes/SubscribeButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L16)
[src/parser/classes/SubscribeButton.ts:16](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L16)
***
### title
### target\_id?
> **title**: [`Text`](../../Misc/classes/Text.md)
> `optional` **target\_id**: `string`
#### Defined in
[src/parser/classes/SubscribeButton.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L10)
[src/parser/classes/SubscribeButton.ts:23](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L23)
***
@@ -130,7 +180,17 @@
#### Defined in
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8)
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8)
***
### unsubscribe\_accessibility\_label?
> `optional` **unsubscribe\_accessibility\_label**: `string`
#### Defined in
[src/parser/classes/SubscribeButton.ts:25](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L25)
***
@@ -140,7 +200,7 @@
#### Defined in
[src/parser/classes/SubscribeButton.ts:17](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L17)
[src/parser/classes/SubscribeButton.ts:17](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L17)
***
@@ -154,7 +214,7 @@
#### Defined in
[src/parser/classes/SubscribeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/classes/SubscribeButton.ts#L8)
[src/parser/classes/SubscribeButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/SubscribeButton.ts#L8)
## Methods
@@ -174,17 +234,25 @@ Cast to one of the given types.
• ...**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`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as)
#### Defined in
[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35)
[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38)
***
@@ -218,7 +286,7 @@ Whether the node has the key
#### Defined in
[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47)
[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50)
***
@@ -252,7 +320,7 @@ whether the node is of the given type
#### Defined in
[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28)
[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28)
***
@@ -290,4 +358,4 @@ If the node does not have the key
#### Defined in
[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57)
[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60)