mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-07-01 20:46:14 +00:00
chore(docs): update
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
# Class: Button
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:7](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L7)
|
||||
Defined in: [src/parser/classes/Button.ts:7](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L7)
|
||||
|
||||
## Extends
|
||||
|
||||
@@ -19,7 +19,7 @@ Defined in: [src/parser/classes/Button.ts:7](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **new Button**(`data`): `Button`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:21](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L21)
|
||||
Defined in: [src/parser/classes/Button.ts:21](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L21)
|
||||
|
||||
#### Parameters
|
||||
|
||||
@@ -41,7 +41,7 @@ Defined in: [src/parser/classes/Button.ts:21](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **accessibility**: `AccessibilitySupportedDatas`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L19)
|
||||
Defined in: [src/parser/classes/Button.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L19)
|
||||
|
||||
***
|
||||
|
||||
@@ -49,7 +49,7 @@ Defined in: [src/parser/classes/Button.ts:19](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:18](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L18)
|
||||
Defined in: [src/parser/classes/Button.ts:18](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L18)
|
||||
|
||||
***
|
||||
|
||||
@@ -57,7 +57,7 @@ Defined in: [src/parser/classes/Button.ts:18](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **icon\_type**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:15](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L15)
|
||||
Defined in: [src/parser/classes/Button.ts:15](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L15)
|
||||
|
||||
***
|
||||
|
||||
@@ -65,7 +65,7 @@ Defined in: [src/parser/classes/Button.ts:15](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **is\_disabled**: `boolean`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:16](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L16)
|
||||
Defined in: [src/parser/classes/Button.ts:16](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L16)
|
||||
|
||||
***
|
||||
|
||||
@@ -73,7 +73,7 @@ Defined in: [src/parser/classes/Button.ts:16](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **label**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L11)
|
||||
Defined in: [src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L11)
|
||||
|
||||
***
|
||||
|
||||
@@ -81,7 +81,7 @@ Defined in: [src/parser/classes/Button.ts:11](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **size**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L14)
|
||||
Defined in: [src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L14)
|
||||
|
||||
***
|
||||
|
||||
@@ -89,7 +89,7 @@ Defined in: [src/parser/classes/Button.ts:14](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **style**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L13)
|
||||
Defined in: [src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L13)
|
||||
|
||||
***
|
||||
|
||||
@@ -97,7 +97,7 @@ Defined in: [src/parser/classes/Button.ts:13](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **target\_id**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:17](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L17)
|
||||
Defined in: [src/parser/classes/Button.ts:17](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L17)
|
||||
|
||||
***
|
||||
|
||||
@@ -105,7 +105,7 @@ Defined in: [src/parser/classes/Button.ts:17](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **text**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L10)
|
||||
Defined in: [src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L10)
|
||||
|
||||
***
|
||||
|
||||
@@ -113,7 +113,7 @@ Defined in: [src/parser/classes/Button.ts:10](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `optional` **tooltip**: `string`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L12)
|
||||
Defined in: [src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L12)
|
||||
|
||||
***
|
||||
|
||||
@@ -121,7 +121,7 @@ Defined in: [src/parser/classes/Button.ts:12](https://github.com/LuanRT/YouTube.
|
||||
|
||||
> `readonly` **type**: `string`
|
||||
|
||||
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L8)
|
||||
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L8)
|
||||
|
||||
#### Inherited from
|
||||
|
||||
@@ -133,7 +133,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
|
||||
|
||||
> `static` **type**: `string` = `'Button'`
|
||||
|
||||
Defined in: [src/parser/classes/Button.ts:8](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/classes/Button.ts#L8)
|
||||
Defined in: [src/parser/classes/Button.ts:8](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/classes/Button.ts#L8)
|
||||
|
||||
#### Overrides
|
||||
|
||||
@@ -145,7 +145,7 @@ Defined in: [src/parser/classes/Button.ts:8](https://github.com/LuanRT/YouTube.j
|
||||
|
||||
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
|
||||
|
||||
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L29)
|
||||
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L29)
|
||||
|
||||
Cast to one of the given types.
|
||||
|
||||
@@ -187,7 +187,7 @@ If the node is not of the given type
|
||||
|
||||
> **hasKey**\<`T`, `R`\>(`key`): `this is Button & { [k in string]: R }`
|
||||
|
||||
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L41)
|
||||
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L41)
|
||||
|
||||
Check for a key without asserting the type.
|
||||
|
||||
@@ -225,7 +225,7 @@ Whether the node has the key
|
||||
|
||||
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
|
||||
|
||||
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L19)
|
||||
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L19)
|
||||
|
||||
Check if the node is of the given type.
|
||||
|
||||
@@ -263,7 +263,7 @@ whether the node is of the given type
|
||||
|
||||
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md)
|
||||
|
||||
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L51)
|
||||
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L51)
|
||||
|
||||
Assert that the node has the given key and return it.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user