chore: Use latest version of typedoc-plugin-markdown

2026-06-19 20:41:17 +00:00 · 2025-10-12 12:03:26 -03:00
parent 41b810629b
commit 0733f60b57
696 changed files with 2256 additions and 131099 deletions
--- a/docs/api/namespaces/Parser/functions/addRuntimeParser.md
+++ b/docs/api/namespaces/Parser/functions/addRuntimeParser.md
@@ -1,19 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / addRuntimeParser
-
-# Function: addRuntimeParser()
-
-> **addRuntimeParser**(`classname`, `ParserConstructor`): `void`
-
-## Parameters
-
-• **classname**: `string`
-
-• **ParserConstructor**: [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
-
-## Returns
-
-`void`
-
-## Defined in
-
-[src/parser/parser.ts:218](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L218)
--- a/docs/api/namespaces/Parser/functions/applyCommentsMutations.md
+++ b/docs/api/namespaces/Parser/functions/applyCommentsMutations.md
@@ -1,19 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / applyCommentsMutations
-
-# Function: applyCommentsMutations()
-
-> **applyCommentsMutations**(`memo`, `mutations`): `void`
-
-## Parameters
-
-• **memo**: [`Memo`](../../Helpers/classes/Memo.md)
-
-• **mutations**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[]
-
-## Returns
-
-`void`
-
-## Defined in
-
-[src/parser/parser.ts:825](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L825)
--- a/docs/api/namespaces/Parser/functions/applyMutations.md
+++ b/docs/api/namespaces/Parser/functions/applyMutations.md
@@ -1,19 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / applyMutations
-
-# Function: applyMutations()
-
-> **applyMutations**(`memo`, `mutations`): `void`
-
-## Parameters
-
-• **memo**: [`Memo`](../../Helpers/classes/Memo.md)
-
-• **mutations**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[]
-
-## Returns
-
-`void`
-
-## Defined in
-
-[src/parser/parser.ts:771](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L771)
--- a/docs/api/namespaces/Parser/functions/getDynamicParsers.md
+++ b/docs/api/namespaces/Parser/functions/getDynamicParsers.md
@@ -1,13 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / getDynamicParsers
-
-# Function: getDynamicParsers()
-
-> **getDynamicParsers**(): `object`
-
-## Returns
-
-`object`
-
-## Defined in
-
-[src/parser/parser.ts:223](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L223)
--- a/docs/api/namespaces/Parser/functions/hasParser.md
+++ b/docs/api/namespaces/Parser/functions/hasParser.md
@@ -1,17 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / hasParser
-
-# Function: hasParser()
-
-> **hasParser**(`classname`): `boolean`
-
-## Parameters
-
-• **classname**: `string`
-
-## Returns
-
-`boolean`
-
-## Defined in
-
-[src/parser/parser.ts:214](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L214)
--- a/docs/api/namespaces/Parser/functions/parse.md
+++ b/docs/api/namespaces/Parser/functions/parse.md
@@ -1,87 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / parse
-
-# Function: parse()
-
-## parse(data, requireArray, validTypes)
-
-> **parse**\<`T`, `K`\>(`data`, `requireArray`, `validTypes`?): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\> \| `null`
-
-Parses an item or an array of items.
-
-### Type Parameters
-
-• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
-
-• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
-
-### Parameters
-
-• **data**: [`RawData`](../../APIResponseTypes/type-aliases/RawData.md)
-
-The data to parse.
-
-• **requireArray**: `true`
-
-Whether the data should be parsed as an array.
-
-• **validTypes?**: `K`
-
-YTNode types that are allowed to be parsed.
-
-### Returns
-
-[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\> \| `null`
-
-### Defined in
-
-[src/parser/parser.ts:628](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L628)
-
-## parse(data, requireArray, validTypes)
-
-> **parse**\<`T`, `K`\>(`data`, `requireArray`, `validTypes`?): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\>\> \| `null`
-
-### Type Parameters
-
-• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
-
-• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>
-
-### Parameters
-
-• **data**: [`RawData`](../../APIResponseTypes/type-aliases/RawData.md)
-
-• **requireArray**: `true`
-
-• **validTypes?**: `K`
-
-### Returns
-
-[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\>\> \| `null`
-
-### Defined in
-
-[src/parser/parser.ts:629](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L629)
-
-## parse(data, requireArray, validTypes)
-
-> **parse**\<`T`\>(`data`?, `requireArray`?, `validTypes`?): [`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<`T`\>
-
-### Type Parameters
-
-• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) = [`YTNode`](../../Helpers/classes/YTNode.md)
-
-### Parameters
-
-• **data?**: [`RawData`](../../APIResponseTypes/type-aliases/RawData.md)
-
-• **requireArray?**: `false`
-
-• **validTypes?**: [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\> \| [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
-
-### Returns
-
-[`SuperParsedResult`](../../Helpers/classes/SuperParsedResult.md)\<`T`\>
-
-### Defined in
-
-[src/parser/parser.ts:630](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L630)
--- a/docs/api/namespaces/Parser/functions/parseArray.md
+++ b/docs/api/namespaces/Parser/functions/parseArray.md
@@ -1,71 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / parseArray
-
-# Function: parseArray()
-
-## parseArray(data, validTypes)
-
-> **parseArray**\<`T`, `K`\>(`data`, `validTypes`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\>
-
-Parses an array of items.
-
-### Type Parameters
-
-• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
-
-• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
-
-### Parameters
-
-• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[]
-
-The data to parse.
-
-• **validTypes**: `K`
-
-YTNode types that are allowed to be parsed.
-
-### Returns
-
-[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\>
-
-### Defined in
-
-[src/parser/parser.ts:601](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L601)
-
-## parseArray(data, validType)
-
-> **parseArray**\<`T`\>(`data`, `validType`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`T`\>
-
-### Type Parameters
-
-• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md) = [`YTNode`](../../Helpers/classes/YTNode.md)
-
-### Parameters
-
-• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[]
-
-• **validType**: [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>
-
-### Returns
-
-[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<`T`\>
-
-### Defined in
-
-[src/parser/parser.ts:602](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L602)
-
-## parseArray(data)
-
-> **parseArray**(`data`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
-
-### Parameters
-
-• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[]
-
-### Returns
-
-[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
-
-### Defined in
-
-[src/parser/parser.ts:603](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L603)
--- a/docs/api/namespaces/Parser/functions/parseC.md
+++ b/docs/api/namespaces/Parser/functions/parseC.md
@@ -1,17 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / parseC
-
-# Function: parseC()
-
-> **parseC**(`data`): `null` \| [`Continuation`](../../../classes/Continuation.md)
-
-## Parameters
-
-• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
-
-## Returns
-
-`null` \| [`Continuation`](../../../classes/Continuation.md)
-
-## Defined in
-
-[src/parser/parser.ts:715](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L715)
--- a/docs/api/namespaces/Parser/functions/parseCommands.md
+++ b/docs/api/namespaces/Parser/functions/parseCommands.md
@@ -1,23 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / parseCommands
-
-# Function: parseCommands()
-
-> **parseCommands**(`commands`?): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
-
-Parses an array of InnerTube command nodes.
-
-## Parameters
-
-• **commands?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[]
-
-Array of raw command nodes to parse
-
-## Returns
-
-[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
-
-An observed array of parsed YTNodes
-
-## Defined in
-
-[src/parser/parser.ts:699](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L699)
--- a/docs/api/namespaces/Parser/functions/parseFormats.md
+++ b/docs/api/namespaces/Parser/functions/parseFormats.md
@@ -1,19 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / parseFormats
-
-# Function: parseFormats()
-
-> **parseFormats**(`formats`, `this_response_nsig_cache`): [`Format`](../../Misc/classes/Format.md)[]
-
-## Parameters
-
-• **formats**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[]
-
-• **this\_response\_nsig\_cache**: `Map`\<`string`, `string`\>
-
-## Returns
-
-[`Format`](../../Misc/classes/Format.md)[]
-
-## Defined in
-
-[src/parser/parser.ts:767](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L767)
--- a/docs/api/namespaces/Parser/functions/parseItem.md
+++ b/docs/api/namespaces/Parser/functions/parseItem.md
@@ -1,71 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / parseItem
-
-# Function: parseItem()
-
-## parseItem(data, validTypes)
-
-> **parseItem**\<`T`, `K`\>(`data`, `validTypes`): `InstanceType`\<`K`\[`number`\]\> \| `null`
-
-Parses an item.
-
-### Type Parameters
-
-• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
-
-• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
-
-### Parameters
-
-• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
-
-The data to parse.
-
-• **validTypes**: `K`
-
-YTNode types that are allowed to be parsed.
-
-### Returns
-
-`InstanceType`\<`K`\[`number`\]\> \| `null`
-
-### Defined in
-
-[src/parser/parser.ts:535](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L535)
-
-## parseItem(data, validTypes)
-
-> **parseItem**\<`T`\>(`data`, `validTypes`): `T` \| `null`
-
-### Type Parameters
-
-• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
-
-### Parameters
-
-• **data**: `undefined` \| [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
-
-• **validTypes**: [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>
-
-### Returns
-
-`T` \| `null`
-
-### Defined in
-
-[src/parser/parser.ts:536](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L536)
-
-## parseItem(data)
-
-> **parseItem**(`data`?): [`YTNode`](../../Helpers/classes/YTNode.md)
-
-### Parameters
-
-• **data?**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
-
-### Returns
-
-[`YTNode`](../../Helpers/classes/YTNode.md)
-
-### Defined in
-
-[src/parser/parser.ts:537](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L537)
--- a/docs/api/namespaces/Parser/functions/parseLC.md
+++ b/docs/api/namespaces/Parser/functions/parseLC.md
@@ -1,17 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / parseLC
-
-# Function: parseLC()
-
-> **parseLC**(`data`): `null` \| [`ItemSectionContinuation`](../../../classes/ItemSectionContinuation.md) \| [`SectionListContinuation`](../../../classes/SectionListContinuation.md) \| [`LiveChatContinuation`](../../../classes/LiveChatContinuation.md) \| [`MusicPlaylistShelfContinuation`](../../../classes/MusicPlaylistShelfContinuation.md) \| [`MusicShelfContinuation`](../../../classes/MusicShelfContinuation.md) \| [`GridContinuation`](../../../classes/GridContinuation.md) \| [`PlaylistPanelContinuation`](../../../classes/PlaylistPanelContinuation.md) \| [`ContinuationCommand`](../../../classes/ContinuationCommand.md)
-
-## Parameters
-
-• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
-
-## Returns
-
-`null` \| [`ItemSectionContinuation`](../../../classes/ItemSectionContinuation.md) \| [`SectionListContinuation`](../../../classes/SectionListContinuation.md) \| [`LiveChatContinuation`](../../../classes/LiveChatContinuation.md) \| [`MusicPlaylistShelfContinuation`](../../../classes/MusicPlaylistShelfContinuation.md) \| [`MusicShelfContinuation`](../../../classes/MusicShelfContinuation.md) \| [`GridContinuation`](../../../classes/GridContinuation.md) \| [`PlaylistPanelContinuation`](../../../classes/PlaylistPanelContinuation.md) \| [`ContinuationCommand`](../../../classes/ContinuationCommand.md)
-
-## Defined in
-
-[src/parser/parser.ts:721](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L721)
--- a/docs/api/namespaces/Parser/functions/parseRR.md
+++ b/docs/api/namespaces/Parser/functions/parseRR.md
@@ -1,17 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / parseRR
-
-# Function: parseRR()
-
-> **parseRR**(`actions`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`NavigateAction`](../../../classes/NavigateAction.md) \| [`ShowMiniplayerCommand`](../../../classes/ShowMiniplayerCommand.md)\>
-
-## Parameters
-
-• **actions**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)[]
-
-## Returns
-
-[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md) \| [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md) \| [`ReloadContinuationItemsCommand`](../../../classes/ReloadContinuationItemsCommand.md) \| [`NavigateAction`](../../../classes/NavigateAction.md) \| [`ShowMiniplayerCommand`](../../../classes/ShowMiniplayerCommand.md)\>
-
-## Defined in
-
-[src/parser/parser.ts:742](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L742)
--- a/docs/api/namespaces/Parser/functions/parseResponse.md
+++ b/docs/api/namespaces/Parser/functions/parseResponse.md
@@ -1,25 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / parseResponse
-
-# Function: parseResponse()
-
-> **parseResponse**\<`T`\>(`data`): `T`
-
-Parses a given InnerTube response.
-
-## Type Parameters
-
-• **T** *extends* [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md) = [`IParsedResponse`](../../APIResponseTypes/interfaces/IParsedResponse.md)
-
-## Parameters
-
-• **data**: [`IRawResponse`](../../APIResponseTypes/interfaces/IRawResponse.md)
-
-Raw data.
-
-## Returns
-
-`T`
-
-## Defined in
-
-[src/parser/parser.ts:231](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L231)
--- a/docs/api/namespaces/Parser/functions/sanitizeClassName.md
+++ b/docs/api/namespaces/Parser/functions/sanitizeClassName.md
@@ -1,17 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / sanitizeClassName
-
-# Function: sanitizeClassName()
-
-> **sanitizeClassName**(`input`): `string`
-
-## Parameters
-
-• **input**: `string`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[src/parser/parser.ts:196](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L196)
--- a/docs/api/namespaces/Parser/functions/setParserErrorHandler.md
+++ b/docs/api/namespaces/Parser/functions/setParserErrorHandler.md
@@ -1,17 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / setParserErrorHandler
-
-# Function: setParserErrorHandler()
-
-> **setParserErrorHandler**(`handler`): `void`
-
-## Parameters
-
-• **handler**: [`ParserErrorHandler`](../type-aliases/ParserErrorHandler.md)
-
-## Returns
-
-`void`
-
-## Defined in
-
-[src/parser/parser.ts:163](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L163)
--- a/docs/api/namespaces/Parser/functions/shouldIgnore.md
+++ b/docs/api/namespaces/Parser/functions/shouldIgnore.md
@@ -1,17 +0,0 @@
-[youtubei.js](../../../README.md) / [Parser](../README.md) / shouldIgnore
-
-# Function: shouldIgnore()
-
-> **shouldIgnore**(`classname`): `boolean`
-
-## Parameters
-
-• **classname**: `string`
-
-## Returns
-
-`boolean`
-
-## Defined in
-
-[src/parser/parser.ts:192](https://github.com/LuanRT/YouTube.js/blob/af92984523f90200a18314b94478a2697c9deab0/src/parser/parser.ts#L192)