chore: add proper documentation (#763)

* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
2026-06-20 04:51:16 +00:00 · 2024-09-23 17:32:50 -03:00
parent dd7f5cf778
commit 74659fd03f
853 changed files with 139814 additions and 1929 deletions
--- a/docs/api/namespaces/YTNodes/classes/EndscreenElement.md
+++ b/docs/api/namespaces/YTNodes/classes/EndscreenElement.md
@@ -0,0 +1,373 @@
+[youtubei.js](../../../README.md) / [YTNodes](../README.md) / EndscreenElement
+
+# Class: EndscreenElement
+
+## Extends
+
+- [`YTNode`](../../Helpers/classes/YTNode.md)
+
+## Constructors
+
+### new EndscreenElement()
+
+> **new EndscreenElement**(`data`): [`EndscreenElement`](EndscreenElement.md)
+
+#### Parameters
+
+• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
+
+#### Returns
+
+[`EndscreenElement`](EndscreenElement.md)
+
+#### Overrides
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors)
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:29](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L29)
+
+## Properties
+
+### aspect\_ratio
+
+> **aspect\_ratio**: `number`
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:24](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L24)
+
+***
+
+### call\_to\_action?
+
+> `optional` **call\_to\_action**: [`Text`](../../Misc/classes/Text.md)
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:16](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L16)
+
+***
+
+### end\_ms
+
+> **end\_ms**: `number`
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:26](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L26)
+
+***
+
+### endpoint
+
+> **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:12](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L12)
+
+***
+
+### hovercard\_button?
+
+> `optional` **hovercard\_button**: [`YTNode`](../../Helpers/classes/YTNode.md)
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:17](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L17)
+
+***
+
+### icon?
+
+> `optional` **icon**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[]
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:14](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L14)
+
+***
+
+### id
+
+> **id**: `string`
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:27](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L27)
+
+***
+
+### image?
+
+> `optional` **image**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[]
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:13](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L13)
+
+***
+
+### is\_subscribe?
+
+> `optional` **is\_subscribe**: `boolean`
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:18](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L18)
+
+***
+
+### left
+
+> **left**: `number`
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:21](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L21)
+
+***
+
+### metadata?
+
+> `optional` **metadata**: [`Text`](../../Misc/classes/Text.md)
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:15](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L15)
+
+***
+
+### playlist\_length?
+
+> `optional` **playlist\_length**: [`Text`](../../Misc/classes/Text.md)
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:19](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L19)
+
+***
+
+### start\_ms
+
+> **start\_ms**: `number`
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:25](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L25)
+
+***
+
+### style
+
+> **style**: `string`
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:10](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L10)
+
+***
+
+### thumbnail\_overlays?
+
+> `optional` **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:20](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L20)
+
+***
+
+### title
+
+> **title**: [`Text`](../../Misc/classes/Text.md)
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:11](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L11)
+
+***
+
+### top
+
+> **top**: `number`
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:22](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L22)
+
+***
+
+### type
+
+> `readonly` **type**: `string`
+
+#### Inherited from
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type)
+
+#### Defined in
+
+[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L8)
+
+***
+
+### width
+
+> **width**: `number`
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:23](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L23)
+
+***
+
+### type
+
+> `static` **type**: `string` = `'EndscreenElement'`
+
+#### Overrides
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1)
+
+#### Defined in
+
+[src/parser/classes/EndscreenElement.ts:8](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/classes/EndscreenElement.ts#L8)
+
+## Methods
+
+### as()
+
+> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
+
+Cast to one of the given types.
+
+#### Type Parameters
+
+• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
+
+• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
+
+#### Parameters
+
+• ...**types**: `K`
+
+#### Returns
+
+`InstanceType`\<`K`\[`number`\]\>
+
+#### 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/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L35)
+
+***
+
+### hasKey()
+
+> **hasKey**\<`T`, `R`\>(`key`): `this is EndscreenElement & { [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 EndscreenElement & { [k in string]: R }`
+
+Whether the node has the key
+
+#### Inherited from
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`hasKey`](../../Helpers/classes/YTNode.md#haskey)
+
+#### Defined in
+
+[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L47)
+
+***
+
+### is()
+
+> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
+
+Check if the node is of the given type.
+
+#### Type Parameters
+
+• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
+
+• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`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`](../../Helpers/classes/YTNode.md).[`is`](../../Helpers/classes/YTNode.md#is)
+
+#### Defined in
+
+[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L28)
+
+***
+
+### key()
+
+> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md)
+
+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`](../../Helpers/classes/Maybe.md)
+
+The value of the key wrapped in a Maybe
+
+#### Throws
+
+If the node does not have the key
+
+#### Inherited from
+
+[`YTNode`](../../Helpers/classes/YTNode.md).[`key`](../../Helpers/classes/YTNode.md#key)
+
+#### Defined in
+
+[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L57)