From 147efd06142fce4a9e501bb6d7b4a10988f54c1c Mon Sep 17 00:00:00 2001 From: Luan Date: Sun, 8 Jun 2025 13:53:02 -0300 Subject: [PATCH] chore: gen docs [skip ci] --- .../Misc/classes/AccessibilityContext.md | 31 ++ .../Misc/classes/AccessibilityData.md | 51 +++ .../namespaces/Misc/classes/CommandContext.md | 121 +++++++ .../Misc/classes/SubscriptionButton.md | 61 ++++ .../Utils/functions/findVariable.md | 40 +++ .../Utils/type-aliases/ASTLookupArgs.md | 35 ++ .../Utils/type-aliases/ASTLookupResult.md | 31 ++ .../classes/AnimatedThumbnailOverlayView.md | 211 ++++++++++++ .../YTNodes/classes/MacroMarkersListEntity.md | 323 ++++++++++++++++++ .../OpenOnePickAddVideoModalCommand.md | 231 +++++++++++++ .../classes/ThumbnailBottomOverlayView.md | 221 ++++++++++++ .../ThumbnailHoverOverlayToggleActionsView.md | 211 ++++++++++++ .../ThumbnailOverlayProgressBarView.md | 211 ++++++++++++ .../UpdateEngagementPanelContentCommand.md | 221 ++++++++++++ 14 files changed, 1999 insertions(+) create mode 100644 docs/api/namespaces/Misc/classes/AccessibilityContext.md create mode 100644 docs/api/namespaces/Misc/classes/AccessibilityData.md create mode 100644 docs/api/namespaces/Misc/classes/CommandContext.md create mode 100644 docs/api/namespaces/Misc/classes/SubscriptionButton.md create mode 100644 docs/api/namespaces/Utils/functions/findVariable.md create mode 100644 docs/api/namespaces/Utils/type-aliases/ASTLookupArgs.md create mode 100644 docs/api/namespaces/Utils/type-aliases/ASTLookupResult.md create mode 100644 docs/api/namespaces/YTNodes/classes/AnimatedThumbnailOverlayView.md create mode 100644 docs/api/namespaces/YTNodes/classes/MacroMarkersListEntity.md create mode 100644 docs/api/namespaces/YTNodes/classes/OpenOnePickAddVideoModalCommand.md create mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailBottomOverlayView.md create mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayToggleActionsView.md create mode 100644 docs/api/namespaces/YTNodes/classes/ThumbnailOverlayProgressBarView.md create mode 100644 docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelContentCommand.md diff --git a/docs/api/namespaces/Misc/classes/AccessibilityContext.md b/docs/api/namespaces/Misc/classes/AccessibilityContext.md new file mode 100644 index 00000000..6548c9ea --- /dev/null +++ b/docs/api/namespaces/Misc/classes/AccessibilityContext.md @@ -0,0 +1,31 @@ +[youtubei.js](../../../README.md) / [Misc](../README.md) / AccessibilityContext + +# Class: AccessibilityContext + +## Constructors + +### new AccessibilityContext() + +> **new AccessibilityContext**(`data`): [`AccessibilityContext`](AccessibilityContext.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`AccessibilityContext`](AccessibilityContext.md) + +#### Defined in + +[src/parser/classes/misc/AccessibilityContext.ts:6](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/AccessibilityContext.ts#L6) + +## Properties + +### label + +> **label**: `string` + +#### Defined in + +[src/parser/classes/misc/AccessibilityContext.ts:4](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/AccessibilityContext.ts#L4) diff --git a/docs/api/namespaces/Misc/classes/AccessibilityData.md b/docs/api/namespaces/Misc/classes/AccessibilityData.md new file mode 100644 index 00000000..58ab32a2 --- /dev/null +++ b/docs/api/namespaces/Misc/classes/AccessibilityData.md @@ -0,0 +1,51 @@ +[youtubei.js](../../../README.md) / [Misc](../README.md) / AccessibilityData + +# Class: AccessibilityData + +## Constructors + +### new AccessibilityData() + +> **new AccessibilityData**(`data`): [`AccessibilityData`](AccessibilityData.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`AccessibilityData`](AccessibilityData.md) + +#### Defined in + +[src/parser/classes/misc/AccessibilityData.ts:120](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/AccessibilityData.ts#L120) + +## Properties + +### accessibility\_identifier? + +> `optional` **accessibility\_identifier**: `string` + +#### Defined in + +[src/parser/classes/misc/AccessibilityData.ts:116](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/AccessibilityData.ts#L116) + +*** + +### identifier? + +> `optional` **identifier**: `AccessibilityId` + +#### Defined in + +[src/parser/classes/misc/AccessibilityData.ts:117](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/AccessibilityData.ts#L117) + +*** + +### label? + +> `optional` **label**: `string` + +#### Defined in + +[src/parser/classes/misc/AccessibilityData.ts:118](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/AccessibilityData.ts#L118) diff --git a/docs/api/namespaces/Misc/classes/CommandContext.md b/docs/api/namespaces/Misc/classes/CommandContext.md new file mode 100644 index 00000000..3c3cd97d --- /dev/null +++ b/docs/api/namespaces/Misc/classes/CommandContext.md @@ -0,0 +1,121 @@ +[youtubei.js](../../../README.md) / [Misc](../README.md) / CommandContext + +# Class: CommandContext + +## Constructors + +### new CommandContext() + +> **new CommandContext**(`data`): [`CommandContext`](CommandContext.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`CommandContext`](CommandContext.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:16](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L16) + +## Properties + +### on\_first\_visible? + +> `optional` **on\_first\_visible**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:13](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L13) + +*** + +### on\_focus? + +> `optional` **on\_focus**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:5](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L5) + +*** + +### on\_hidden? + +> `optional` **on\_hidden**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:6](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L6) + +*** + +### on\_hover? + +> `optional` **on\_hover**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:14](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L14) + +*** + +### on\_long\_press? + +> `optional` **on\_long\_press**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:9](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L9) + +*** + +### on\_tap? + +> `optional` **on\_tap**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:10](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L10) + +*** + +### on\_touch\_end? + +> `optional` **on\_touch\_end**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:7](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L7) + +*** + +### on\_touch\_move? + +> `optional` **on\_touch\_move**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:8](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L8) + +*** + +### on\_touch\_start? + +> `optional` **on\_touch\_start**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:11](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L11) + +*** + +### on\_visible? + +> `optional` **on\_visible**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) + +#### Defined in + +[src/parser/classes/misc/CommandContext.ts:12](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/CommandContext.ts#L12) diff --git a/docs/api/namespaces/Misc/classes/SubscriptionButton.md b/docs/api/namespaces/Misc/classes/SubscriptionButton.md new file mode 100644 index 00000000..e82627b1 --- /dev/null +++ b/docs/api/namespaces/Misc/classes/SubscriptionButton.md @@ -0,0 +1,61 @@ +[youtubei.js](../../../README.md) / [Misc](../README.md) / SubscriptionButton + +# Class: SubscriptionButton + +## Constructors + +### new SubscriptionButton() + +> **new SubscriptionButton**(`data`): [`SubscriptionButton`](SubscriptionButton.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`SubscriptionButton`](SubscriptionButton.md) + +#### Defined in + +[src/parser/classes/misc/SubscriptionButton.ts:11](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/SubscriptionButton.ts#L11) + +## Properties + +### subscribed + +> **subscribed**: `boolean` + +#### Defined in + +[src/parser/classes/misc/SubscriptionButton.ts:8](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/SubscriptionButton.ts#L8) + +*** + +### subscription\_type? + +> `optional` **subscription\_type**: `"FREE"` \| `"PAID"` \| `"UNAVAILABLE"` + +#### Defined in + +[src/parser/classes/misc/SubscriptionButton.ts:9](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/SubscriptionButton.ts#L9) + +*** + +### text + +> **text**: [`Text`](Text.md) + +#### Defined in + +[src/parser/classes/misc/SubscriptionButton.ts:7](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/SubscriptionButton.ts#L7) + +*** + +### type + +> `static` **type**: `string` = `'SubscriptionButton'` + +#### Defined in + +[src/parser/classes/misc/SubscriptionButton.ts:5](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/misc/SubscriptionButton.ts#L5) diff --git a/docs/api/namespaces/Utils/functions/findVariable.md b/docs/api/namespaces/Utils/functions/findVariable.md new file mode 100644 index 00000000..3dca0602 --- /dev/null +++ b/docs/api/namespaces/Utils/functions/findVariable.md @@ -0,0 +1,40 @@ +[youtubei.js](../../../README.md) / [Utils](../README.md) / findVariable + +# Function: findVariable() + +> **findVariable**(`code`, `options`): [`ASTLookupResult`](../type-aliases/ASTLookupResult.md) \| `undefined` + +Searches for a variable declaration in the given code based on specified criteria. + +## Parameters + +• **code**: `string` + +• **options**: [`ASTLookupArgs`](../type-aliases/ASTLookupArgs.md) + +## Returns + +[`ASTLookupResult`](../type-aliases/ASTLookupResult.md) \| `undefined` + +An object containing the variable's details if found, `undefined` otherwise. + +## Example + +```ts +// Find a variable by name +const code = 'const x = 5; let y = "hello";'; +const a = findVariable(code, { name: 'y' }); +console.log(a?.result); + +// Find a variable containing specific text +const b = findVariable(code, { includes: 'hello' }); +console.log(b?.result); + +// Find a variable matching a pattern +const c = findVariable(code, { regexp: /y\s*=\s*"hello"/ }); +console.log(c?.result); +``` + +## Defined in + +[src/utils/Utils.ts:376](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/utils/Utils.ts#L376) diff --git a/docs/api/namespaces/Utils/type-aliases/ASTLookupArgs.md b/docs/api/namespaces/Utils/type-aliases/ASTLookupArgs.md new file mode 100644 index 00000000..cb06e13c --- /dev/null +++ b/docs/api/namespaces/Utils/type-aliases/ASTLookupArgs.md @@ -0,0 +1,35 @@ +[youtubei.js](../../../README.md) / [Utils](../README.md) / ASTLookupArgs + +# Type Alias: ASTLookupArgs + +> **ASTLookupArgs**: `object` + +## Type declaration + +### ast? + +> `optional` **ast**: `ReturnType`\<*typeof* `Jinter.parseScript`\> + +The abstract syntax tree of the source code. + +### includes? + +> `optional` **includes**: `string` + +A string that must be included in the function's code for it to be considered. + +### name? + +> `optional` **name**: `string` + +The name of the function. + +### regexp? + +> `optional` **regexp**: `RegExp` + +A regular expression that the function's code must match. + +## Defined in + +[src/utils/Utils.ts:268](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/utils/Utils.ts#L268) diff --git a/docs/api/namespaces/Utils/type-aliases/ASTLookupResult.md b/docs/api/namespaces/Utils/type-aliases/ASTLookupResult.md new file mode 100644 index 00000000..b782e593 --- /dev/null +++ b/docs/api/namespaces/Utils/type-aliases/ASTLookupResult.md @@ -0,0 +1,31 @@ +[youtubei.js](../../../README.md) / [Utils](../README.md) / ASTLookupResult + +# Type Alias: ASTLookupResult + +> **ASTLookupResult**: `object` + +## Type declaration + +### end + +> **end**: `number` + +### name + +> **name**: `string` + +### node + +> **node**: `Record`\<`string`, `any`\> + +### result + +> **result**: `string` + +### start + +> **start**: `number` + +## Defined in + +[src/utils/Utils.ts:290](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/utils/Utils.ts#L290) diff --git a/docs/api/namespaces/YTNodes/classes/AnimatedThumbnailOverlayView.md b/docs/api/namespaces/YTNodes/classes/AnimatedThumbnailOverlayView.md new file mode 100644 index 00000000..48481b85 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/AnimatedThumbnailOverlayView.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / AnimatedThumbnailOverlayView + +# Class: AnimatedThumbnailOverlayView + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new AnimatedThumbnailOverlayView() + +> **new AnimatedThumbnailOverlayView**(`data`): [`AnimatedThumbnailOverlayView`](AnimatedThumbnailOverlayView.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`AnimatedThumbnailOverlayView`](AnimatedThumbnailOverlayView.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/AnimatedThumbnailOverlayView.ts:10](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/AnimatedThumbnailOverlayView.ts#L10) + +## Properties + +### thumbnail + +> **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] + +#### Defined in + +[src/parser/classes/AnimatedThumbnailOverlayView.ts:8](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/AnimatedThumbnailOverlayView.ts#L8) + +*** + +### 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/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'AnimatedThumbnailOverlayView'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/AnimatedThumbnailOverlayView.ts:6](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/AnimatedThumbnailOverlayView.ts#L6) + +## 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 + +[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) + +#### Defined in + +[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L29) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is AnimatedThumbnailOverlayView & { [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 AnimatedThumbnailOverlayView & { [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:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L41) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +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` + +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:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L19) + +*** + +### 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:51](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/MacroMarkersListEntity.md b/docs/api/namespaces/YTNodes/classes/MacroMarkersListEntity.md new file mode 100644 index 00000000..b3059623 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/MacroMarkersListEntity.md @@ -0,0 +1,323 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / MacroMarkersListEntity + +# Class: MacroMarkersListEntity + +Represents a list of markers for a video. Can contain different types of markers: +- MARKER_TYPE_HEATMAP: Heat map markers showing audience engagement data +- Other marker types may exist but are not currently handled + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new MacroMarkersListEntity() + +> **new MacroMarkersListEntity**(`data`): [`MacroMarkersListEntity`](MacroMarkersListEntity.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`MacroMarkersListEntity`](MacroMarkersListEntity.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:30](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L30) + +## Properties + +### external\_video\_id + +> **external\_video\_id**: `string` + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:17](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L17) + +*** + +### marker\_entity\_key + +> **marker\_entity\_key**: `string` + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:16](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L16) + +*** + +### marker\_type + +> **marker\_type**: `string` + +The type of markers in this entity (e.g., 'MARKER_TYPE_HEATMAP') + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L19) + +*** + +### markers + +> **markers**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`HeatMarker`](HeatMarker.md)\> + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:20](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L20) + +*** + +### max\_height\_dp + +> **max\_height\_dp**: `number` + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:21](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L21) + +*** + +### min\_height\_dp + +> **min\_height\_dp**: `number` + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:22](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L22) + +*** + +### show\_hide\_animation\_duration\_millis + +> **show\_hide\_animation\_duration\_millis**: `number` + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:23](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L23) + +*** + +### timed\_marker\_decorations + +> **timed\_marker\_decorations**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`TimedMarkerDecoration`](TimedMarkerDecoration.md)\> + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:24](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L24) + +*** + +### 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/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'MacroMarkersListEntity'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:14](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L14) + +## 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 + +[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) + +#### Defined in + +[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L29) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is MacroMarkersListEntity & { [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 MacroMarkersListEntity & { [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:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L41) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +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` + +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:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L19) + +*** + +### isHeatmap() + +> **isHeatmap**(): `boolean` + +Checks if this MacroMarkersListEntity represents heatmap data. +Only heatmap markers can be converted to Heatmap objects. + +#### Returns + +`boolean` + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:65](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L65) + +*** + +### 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:51](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L51) + +*** + +### toHeatmap() + +> **toHeatmap**(): `null` \| [`Heatmap`](Heatmap.md) + +Converts this MacroMarkersListEntity to a Heatmap object +for compatibility with existing code. Only works for heatmap markers. + +#### Returns + +`null` \| [`Heatmap`](Heatmap.md) + +Heatmap object if this entity contains heatmap data, null otherwise + +#### Defined in + +[src/parser/classes/MacroMarkersListEntity.ts:74](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/MacroMarkersListEntity.ts#L74) diff --git a/docs/api/namespaces/YTNodes/classes/OpenOnePickAddVideoModalCommand.md b/docs/api/namespaces/YTNodes/classes/OpenOnePickAddVideoModalCommand.md new file mode 100644 index 00000000..f6d1abe2 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/OpenOnePickAddVideoModalCommand.md @@ -0,0 +1,231 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / OpenOnePickAddVideoModalCommand + +# Class: OpenOnePickAddVideoModalCommand + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new OpenOnePickAddVideoModalCommand() + +> **new OpenOnePickAddVideoModalCommand**(`data`): [`OpenOnePickAddVideoModalCommand`](OpenOnePickAddVideoModalCommand.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`OpenOnePickAddVideoModalCommand`](OpenOnePickAddVideoModalCommand.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:11](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/OpenOnePickAddVideoModalCommand.ts#L11) + +## Properties + +### list\_id + +> **list\_id**: `string` + +#### Defined in + +[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:7](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/OpenOnePickAddVideoModalCommand.ts#L7) + +*** + +### modal\_title + +> **modal\_title**: `string` + +#### Defined in + +[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:8](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/OpenOnePickAddVideoModalCommand.ts#L8) + +*** + +### select\_button\_label + +> **select\_button\_label**: `string` + +#### Defined in + +[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:9](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/OpenOnePickAddVideoModalCommand.ts#L9) + +*** + +### 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/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'OpenOnePickAddVideoModalCommand'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/OpenOnePickAddVideoModalCommand.ts:5](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/OpenOnePickAddVideoModalCommand.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 + +[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) + +#### Defined in + +[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L29) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is OpenOnePickAddVideoModalCommand & { [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 OpenOnePickAddVideoModalCommand & { [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:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L41) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +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` + +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:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L19) + +*** + +### 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:51](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailBottomOverlayView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailBottomOverlayView.md new file mode 100644 index 00000000..0a8b411e --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailBottomOverlayView.md @@ -0,0 +1,221 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailBottomOverlayView + +# Class: ThumbnailBottomOverlayView + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new ThumbnailBottomOverlayView() + +> **new ThumbnailBottomOverlayView**(`data`): [`ThumbnailBottomOverlayView`](ThumbnailBottomOverlayView.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`ThumbnailBottomOverlayView`](ThumbnailBottomOverlayView.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/ThumbnailBottomOverlayView.ts:13](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailBottomOverlayView.ts#L13) + +## Properties + +### badges + +> **badges**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ThumbnailBadgeView`](ThumbnailBadgeView.md)\> + +#### Defined in + +[src/parser/classes/ThumbnailBottomOverlayView.ts:11](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailBottomOverlayView.ts#L11) + +*** + +### progress\_bar + +> **progress\_bar**: `null` \| [`ThumbnailOverlayProgressBarView`](ThumbnailOverlayProgressBarView.md) + +#### Defined in + +[src/parser/classes/ThumbnailBottomOverlayView.ts:10](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailBottomOverlayView.ts#L10) + +*** + +### 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/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'ThumbnailBottomOverlayView'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/ThumbnailBottomOverlayView.ts:8](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailBottomOverlayView.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` + +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:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L29) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailBottomOverlayView & { [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 ThumbnailBottomOverlayView & { [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:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L41) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +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` + +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:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L19) + +*** + +### 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:51](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayToggleActionsView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayToggleActionsView.md new file mode 100644 index 00000000..5f2cd020 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailHoverOverlayToggleActionsView.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailHoverOverlayToggleActionsView + +# Class: ThumbnailHoverOverlayToggleActionsView + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new ThumbnailHoverOverlayToggleActionsView() + +> **new ThumbnailHoverOverlayToggleActionsView**(`data`): [`ThumbnailHoverOverlayToggleActionsView`](ThumbnailHoverOverlayToggleActionsView.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`ThumbnailHoverOverlayToggleActionsView`](ThumbnailHoverOverlayToggleActionsView.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/ThumbnailHoverOverlayToggleActionsView.ts:11](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailHoverOverlayToggleActionsView.ts#L11) + +## Properties + +### buttons + +> **buttons**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ToggleButtonView`](ToggleButtonView.md)\> + +#### Defined in + +[src/parser/classes/ThumbnailHoverOverlayToggleActionsView.ts:9](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailHoverOverlayToggleActionsView.ts#L9) + +*** + +### 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/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'ThumbnailHoverOverlayToggleActionsView'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/ThumbnailHoverOverlayToggleActionsView.ts:7](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailHoverOverlayToggleActionsView.ts#L7) + +## 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 + +[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) + +#### Defined in + +[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L29) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailHoverOverlayToggleActionsView & { [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 ThumbnailHoverOverlayToggleActionsView & { [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:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L41) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +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` + +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:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L19) + +*** + +### 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:51](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayProgressBarView.md b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayProgressBarView.md new file mode 100644 index 00000000..bf4dfc96 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/ThumbnailOverlayProgressBarView.md @@ -0,0 +1,211 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / ThumbnailOverlayProgressBarView + +# Class: ThumbnailOverlayProgressBarView + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new ThumbnailOverlayProgressBarView() + +> **new ThumbnailOverlayProgressBarView**(`data`): [`ThumbnailOverlayProgressBarView`](ThumbnailOverlayProgressBarView.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`ThumbnailOverlayProgressBarView`](ThumbnailOverlayProgressBarView.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/ThumbnailOverlayProgressBarView.ts:9](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailOverlayProgressBarView.ts#L9) + +## Properties + +### start\_percent + +> **start\_percent**: `number` + +#### Defined in + +[src/parser/classes/ThumbnailOverlayProgressBarView.ts:7](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailOverlayProgressBarView.ts#L7) + +*** + +### 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/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'ThumbnailOverlayProgressBarView'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/ThumbnailOverlayProgressBarView.ts:5](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/ThumbnailOverlayProgressBarView.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 + +[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) + +#### Defined in + +[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L29) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is ThumbnailOverlayProgressBarView & { [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 ThumbnailOverlayProgressBarView & { [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:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L41) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +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` + +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:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L19) + +*** + +### 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:51](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L51) diff --git a/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelContentCommand.md b/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelContentCommand.md new file mode 100644 index 00000000..e334ffe8 --- /dev/null +++ b/docs/api/namespaces/YTNodes/classes/UpdateEngagementPanelContentCommand.md @@ -0,0 +1,221 @@ +[youtubei.js](../../../README.md) / [YTNodes](../README.md) / UpdateEngagementPanelContentCommand + +# Class: UpdateEngagementPanelContentCommand + +## Extends + +- [`YTNode`](../../Helpers/classes/YTNode.md) + +## Constructors + +### new UpdateEngagementPanelContentCommand() + +> **new UpdateEngagementPanelContentCommand**(`data`): [`UpdateEngagementPanelContentCommand`](UpdateEngagementPanelContentCommand.md) + +#### Parameters + +• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md) + +#### Returns + +[`UpdateEngagementPanelContentCommand`](UpdateEngagementPanelContentCommand.md) + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`constructor`](../../Helpers/classes/YTNode.md#constructors) + +#### Defined in + +[src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts:15](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts#L15) + +## Properties + +### content\_source\_panel\_identifier? + +> `optional` **content\_source\_panel\_identifier**: `Identifier` + +#### Defined in + +[src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts:12](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts#L12) + +*** + +### target\_panel\_identifier? + +> `optional` **target\_panel\_identifier**: `Identifier` + +#### Defined in + +[src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts:13](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts#L13) + +*** + +### 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/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L8) + +*** + +### type + +> `static` **type**: `string` = `'UpdateEngagementPanelContentCommand'` + +#### Overrides + +[`YTNode`](../../Helpers/classes/YTNode.md).[`type`](../../Helpers/classes/YTNode.md#type-1) + +#### Defined in + +[src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts:10](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/commands/UpdateEngagementPanelContentCommand.ts#L10) + +## 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 + +[`YTNode`](../../Helpers/classes/YTNode.md).[`as`](../../Helpers/classes/YTNode.md#as) + +#### Defined in + +[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L29) + +*** + +### hasKey() + +> **hasKey**\<`T`, `R`\>(`key`): `this is UpdateEngagementPanelContentCommand & { [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 UpdateEngagementPanelContentCommand & { [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:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L41) + +*** + +### is() + +> **is**\<`T`, `K`\>(...`types`): `this is InstanceType` + +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` + +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:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L19) + +*** + +### 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:51](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L51)