chore(docs): Update API ref

2026-06-24 15:21:54 +00:00 · 2024-11-22 04:25:16 -03:00
parent fc5571629e
commit 4e9d64404e
927 changed files with 26023 additions and 9839 deletions
--- a/docs/api/namespaces/YTNodes/classes/ShareEntityEndpoint.md
+++ b/docs/api/namespaces/YTNodes/classes/ShareEntityEndpoint.md
@@ -0,0 +1,237 @@
+[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ShareEntityEndpoint
+
+# Class: ShareEntityEndpoint
+
+## Extends
+
+- [`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md)
+
+## Constructors
+
+### new ShareEntityEndpoint()
+
+> **new ShareEntityEndpoint**(`data`): [`ShareEntityEndpoint`](ShareEntityEndpoint.md)
+
+#### Parameters
+
+• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
+
+#### Returns
+
+[`ShareEntityEndpoint`](ShareEntityEndpoint.md)
+
+#### Overrides
+
+[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`constructor`](ShareEntityServiceEndpoint.md#constructors)
+
+#### Defined in
+
+[src/parser/classes/endpoints/ShareEntityEndpoint.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityEndpoint.ts#L7)
+
+## Properties
+
+### type
+
+> `readonly` **type**: `string`
+
+#### Inherited from
+
+[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`type`](ShareEntityServiceEndpoint.md#type)
+
+#### Defined in
+
+[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8)
+
+***
+
+### type
+
+> `static` **type**: `string` = `'ShareEntityEndpoint'`
+
+#### Overrides
+
+[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`type`](ShareEntityServiceEndpoint.md#type-1)
+
+#### Defined in
+
+[src/parser/classes/endpoints/ShareEntityEndpoint.ts:5](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityEndpoint.ts#L5)
+
+## 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`
+
+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
+
+[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`as`](ShareEntityServiceEndpoint.md#as)
+
+#### Defined in
+
+[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38)
+
+***
+
+### buildRequest()
+
+> **buildRequest**(): [`ShareEntityServiceRequest`](../../APIResponseTypes/type-aliases/ShareEntityServiceRequest.md)
+
+#### Returns
+
+[`ShareEntityServiceRequest`](../../APIResponseTypes/type-aliases/ShareEntityServiceRequest.md)
+
+#### Inherited from
+
+[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`buildRequest`](ShareEntityServiceEndpoint.md#buildrequest)
+
+#### Defined in
+
+[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:19](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L19)
+
+***
+
+### getApiPath()
+
+> **getApiPath**(): `string`
+
+#### Returns
+
+`string`
+
+#### Inherited from
+
+[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`getApiPath`](ShareEntityServiceEndpoint.md#getapipath)
+
+#### Defined in
+
+[src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/classes/endpoints/ShareEntityServiceEndpoint.ts#L15)
+
+***
+
+### hasKey()
+
+> **hasKey**\<`T`, `R`\>(`key`): `this is ShareEntityEndpoint & { [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 ShareEntityEndpoint & { [k in string]: R }`
+
+Whether the node has the key
+
+#### Inherited from
+
+[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`hasKey`](ShareEntityServiceEndpoint.md#haskey)
+
+#### Defined in
+
+[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50)
+
+***
+
+### 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
+
+[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`is`](ShareEntityServiceEndpoint.md#is)
+
+#### Defined in
+
+[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/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
+
+[`ShareEntityServiceEndpoint`](ShareEntityServiceEndpoint.md).[`key`](ShareEntityServiceEndpoint.md#key)
+
+#### Defined in
+
+[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60)