jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-18 20:12:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Update API ref

Browse Source
This commit is contained in:
Luan
2024-11-22 04:25:16 -03:00
parent fc5571629e
commit 4e9d64404e
927 changed files with 26023 additions and 9839 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/api/namespaces/Helpers/classes/Maybe.md
View File

@@ -2,6 +2,8 @@
# Class: Maybe
A wrapper class that provides type-safe access to a value.
## Constructors
### new Maybe()
@@ -18,7 +20,7 @@
#### Defined in
[src/parser/helpers.ts:69](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L69)
[src/parser/helpers.ts:76](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L76)
## Accessors
@@ -32,7 +34,7 @@
#### Defined in
[src/parser/helpers.ts:87](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L87)
[src/parser/helpers.ts:91](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L91)
## Methods
@@ -50,7 +52,7 @@ This call is not meant to be used outside of debugging. Please use the specific
#### Defined in
[src/parser/helpers.ts:283](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L283)
[src/parser/helpers.ts:287](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L287)
***
@@ -72,7 +74,7 @@ If the value is not an array.
#### Defined in
[src/parser/helpers.ts:171](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L171)
[src/parser/helpers.ts:175](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L175)
***
@@ -94,7 +96,7 @@ If the value is not an array
#### Defined in
[src/parser/helpers.ts:183](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L183)
[src/parser/helpers.ts:187](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L187)
***
@@ -108,7 +110,7 @@ If the value is not an array
#### Defined in
[src/parser/helpers.ts:107](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L107)
[src/parser/helpers.ts:111](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L111)
***
@@ -122,7 +124,7 @@ If the value is not an array
#### Defined in
[src/parser/helpers.ts:115](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L115)
[src/parser/helpers.ts:119](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L119)
***
@@ -136,7 +138,7 @@ If the value is not an array
#### Defined in
[src/parser/helpers.ts:158](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L158)
[src/parser/helpers.ts:162](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L162)
***
@@ -168,7 +170,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:294](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L294)
[src/parser/helpers.ts:298](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L298)
***
@@ -186,7 +188,7 @@ whether the value is an array.
#### Defined in
[src/parser/helpers.ts:199](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L199)
[src/parser/helpers.ts:203](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L203)
***
@@ -200,7 +202,7 @@ whether the value is an array.
#### Defined in
[src/parser/helpers.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L111)
[src/parser/helpers.ts:115](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L115)
***
@@ -214,7 +216,7 @@ whether the value is an array.
#### Defined in
[src/parser/helpers.ts:119](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L119)
[src/parser/helpers.ts:123](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L123)
***
@@ -228,7 +230,7 @@ whether the value is an array.
#### Defined in
[src/parser/helpers.ts:162](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L162)
[src/parser/helpers.ts:166](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L166)
***
@@ -256,7 +258,7 @@ Whether the node is an instance of the given type.
#### Defined in
[src/parser/helpers.ts:306](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L306)
[src/parser/helpers.ts:310](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L310)
***
@@ -274,7 +276,7 @@ Whether the value is a YTNode.
#### Defined in
[src/parser/helpers.ts:219](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L219)
[src/parser/helpers.ts:223](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L223)
***
@@ -304,7 +306,7 @@ Whether the value is a YTNode of the given type.
#### Defined in
[src/parser/helpers.ts:238](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L238)
[src/parser/helpers.ts:242](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L242)
***
@@ -318,7 +320,7 @@ Whether the value is a YTNode of the given type.
#### Defined in
[src/parser/helpers.ts:145](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L145)
[src/parser/helpers.ts:149](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L149)
***
@@ -332,7 +334,7 @@ Whether the value is a YTNode of the given type.
#### Defined in
[src/parser/helpers.ts:103](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L103)
[src/parser/helpers.ts:107](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L107)
***
@@ -346,7 +348,7 @@ Whether the value is a YTNode of the given type.
#### Defined in
[src/parser/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L153)
[src/parser/helpers.ts:157](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L157)
***
@@ -362,7 +364,7 @@ Check if the value is an ObservedArray.
#### Defined in
[src/parser/helpers.ts:256](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L256)
[src/parser/helpers.ts:260](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L260)
***
@@ -378,7 +380,7 @@ Is the result a SuperParsedResult?
#### Defined in
[src/parser/helpers.ts:275](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L275)
[src/parser/helpers.ts:279](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L279)
***
@@ -392,7 +394,7 @@ Is the result a SuperParsedResult?
#### Defined in
[src/parser/helpers.ts:95](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L95)
[src/parser/helpers.ts:99](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L99)
***
@@ -406,7 +408,7 @@ Is the result a SuperParsedResult?
#### Defined in
[src/parser/helpers.ts:127](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L127)
[src/parser/helpers.ts:131](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L131)
***
@@ -420,7 +422,7 @@ Is the result a SuperParsedResult?
#### Defined in
[src/parser/helpers.ts:135](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L135)
[src/parser/helpers.ts:139](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L139)
***
@@ -442,7 +444,7 @@ If the value is not a YTNode.
#### Defined in
[src/parser/helpers.ts:208](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L208)
[src/parser/helpers.ts:212](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L212)
***
@@ -468,7 +470,7 @@ The type(s) to cast to.
`InstanceType`\<`K`\[`number`\]\>
The node casted to the given type.
The node cast to the given type.
#### Throws
@@ -476,7 +478,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:229](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L229)
[src/parser/helpers.ts:233](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L233)
***
@@ -490,7 +492,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:139](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L139)
[src/parser/helpers.ts:143](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L143)
***
@@ -504,7 +506,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:99](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L99)
[src/parser/helpers.ts:103](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L103)
***
@@ -518,7 +520,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L149)
[src/parser/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L153)
***
@@ -536,7 +538,7 @@ the value of the Maybe as a ObservedArray.
#### Defined in
[src/parser/helpers.ts:246](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L246)
[src/parser/helpers.ts:250](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L250)
***
@@ -558,7 +560,7 @@ If the value is not a SuperParsedResult.
#### Defined in
[src/parser/helpers.ts:265](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L265)
[src/parser/helpers.ts:269](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L269)
***
@@ -572,7 +574,7 @@ If the value is not a SuperParsedResult.
#### Defined in
[src/parser/helpers.ts:91](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L91)
[src/parser/helpers.ts:95](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L95)
***
@@ -586,7 +588,7 @@ If the value is not a SuperParsedResult.
#### Defined in
[src/parser/helpers.ts:123](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L123)
[src/parser/helpers.ts:127](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L127)
***
@@ -600,4 +602,4 @@ If the value is not a SuperParsedResult.
#### Defined in
[src/parser/helpers.ts:131](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L131)
[src/parser/helpers.ts:135](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L135)

60
docs/api/namespaces/Helpers/classes/Memo.md
View File

@@ -26,7 +26,7 @@
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:50
node\_modules/typescript/lib/lib.es2015.collection.d.ts:50
### new Memo()
@@ -34,7 +34,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col
#### Parameters
• **iterable?**: `null` \| `Iterable`\<readonly [`string`, [`YTNode`](YTNode.md)[]], `any`, `any`\>
• **iterable?**: `null` \| `Iterable`\<readonly [`string`, [`YTNode`](YTNode.md)[]]\>
#### Returns
@@ -46,7 +46,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:49
node\_modules/typescript/lib/lib.es2015.collection.d.ts:49
## Properties
@@ -60,7 +60,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137
node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:137
***
@@ -68,17 +68,13 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.sym
> `readonly` **size**: `number`
#### Returns
the number of elements in the Map.
#### Inherited from
`Map.size`
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:45
node\_modules/typescript/lib/lib.es2015.collection.d.ts:45
***
@@ -92,19 +88,19 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319
node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319
## Methods
### \[iterator\]()
> **\[iterator\]**(): `MapIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\>
> **\[iterator\]**(): `IterableIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\>
Returns an iterable of entries in the map.
#### Returns
`MapIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\>
`IterableIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\>
#### Inherited from
@@ -112,7 +108,7 @@ Returns an iterable of entries in the map.
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:143
node\_modules/typescript/lib/lib.es2015.iterable.d.ts:119
***
@@ -130,7 +126,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.ite
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:20
node\_modules/typescript/lib/lib.es2015.collection.d.ts:20
***
@@ -154,19 +150,19 @@ true if an element in the Map existed and has been removed, or false if the elem
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:24
node\_modules/typescript/lib/lib.es2015.collection.d.ts:24
***
### entries()
> **entries**(): `MapIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\>
> **entries**(): `IterableIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\>
Returns an iterable of key, value pairs for every entry in the map.
#### Returns
`MapIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\>
`IterableIterator`\<[`string`, [`YTNode`](YTNode.md)[]]\>
#### Inherited from
@@ -174,7 +170,7 @@ Returns an iterable of key, value pairs for every entry in the map.
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:148
node\_modules/typescript/lib/lib.es2015.iterable.d.ts:124
***
@@ -200,7 +196,7 @@ Executes a provided function once per each key/value pair in the Map, in inserti
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:28
node\_modules/typescript/lib/lib.es2015.collection.d.ts:28
***
@@ -226,7 +222,7 @@ Returns the element associated with the specified key. If no element is associat
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:33
node\_modules/typescript/lib/lib.es2015.collection.d.ts:33
***
@@ -252,7 +248,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col
##### Defined in
[src/parser/helpers.ts:478](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L478)
[src/parser/helpers.ts:512](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L512)
#### getType(types)
@@ -274,7 +270,7 @@ node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.col
##### Defined in
[src/parser/helpers.ts:479](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L479)
[src/parser/helpers.ts:513](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L513)
***
@@ -298,19 +294,19 @@ boolean indicating whether an element with the specified key exists or not.
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:37
node\_modules/typescript/lib/lib.es2015.collection.d.ts:37
***
### keys()
> **keys**(): `MapIterator`\<`string`\>
> **keys**(): `IterableIterator`\<`string`\>
Returns an iterable of keys in the map
#### Returns
`MapIterator`\<`string`\>
`IterableIterator`\<`string`\>
#### Inherited from
@@ -318,7 +314,7 @@ Returns an iterable of keys in the map
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:153
node\_modules/typescript/lib/lib.es2015.iterable.d.ts:129
***
@@ -344,19 +340,19 @@ Adds a new element with a specified key and value to the Map. If an element with
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:41
node\_modules/typescript/lib/lib.es2015.collection.d.ts:41
***
### values()
> **values**(): `MapIterator`\<[`YTNode`](YTNode.md)[]\>
> **values**(): `IterableIterator`\<[`YTNode`](YTNode.md)[]\>
Returns an iterable of values in the map
#### Returns
`MapIterator`\<[`YTNode`](YTNode.md)[]\>
`IterableIterator`\<[`YTNode`](YTNode.md)[]\>
#### Inherited from
@@ -364,7 +360,7 @@ Returns an iterable of values in the map
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:158
node\_modules/typescript/lib/lib.es2015.iterable.d.ts:134
***
@@ -382,7 +378,7 @@ Groups members of an iterable according to the return value of the passed callba
#### Parameters
• **items**: `Iterable`\<`T`, `any`, `any`\>
• **items**: `Iterable`\<`T`\>
An iterable.
@@ -400,4 +396,4 @@ A callback which will be invoked for each item in items.
#### Defined in
node\_modules/.deno/typescript@5.6.3/node\_modules/typescript/lib/lib.esnext.collection.d.ts:25
node\_modules/typescript/lib/lib.esnext.collection.d.ts:25

12
docs/api/namespaces/Helpers/classes/SuperParsedResult.md
View File

@@ -24,7 +24,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[]
#### Defined in
[src/parser/helpers.ts:326](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L326)
[src/parser/helpers.ts:330](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L330)
## Accessors
@@ -38,7 +38,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[]
#### Defined in
[src/parser/helpers.ts:333](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L333)
[src/parser/helpers.ts:337](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L337)
***
@@ -52,7 +52,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[]
#### Defined in
[src/parser/helpers.ts:336](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L336)
[src/parser/helpers.ts:340](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L340)
***
@@ -66,7 +66,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[]
#### Defined in
[src/parser/helpers.ts:330](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L330)
[src/parser/helpers.ts:334](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L334)
## Methods
@@ -80,7 +80,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[]
#### Defined in
[src/parser/helpers.ts:340](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L340)
[src/parser/helpers.ts:344](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L344)
***
@@ -94,4 +94,4 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[]
#### Defined in
[src/parser/helpers.ts:347](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L347)
[src/parser/helpers.ts:351](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L351)

77
docs/api/namespaces/Helpers/classes/YTNode.md
View File

@@ -15,7 +15,11 @@
- [`AppendContinuationItemsAction`](../../YTNodes/classes/AppendContinuationItemsAction.md)
- [`GetMultiPageMenuAction`](../../YTNodes/classes/GetMultiPageMenuAction.md)
- [`OpenPopupAction`](../../YTNodes/classes/OpenPopupAction.md)
- [`SendFeedbackAction`](../../YTNodes/classes/SendFeedbackAction.md)
- [`SignalAction`](../../YTNodes/classes/SignalAction.md)
- [`UpdateEngagementPanelAction`](../../YTNodes/classes/UpdateEngagementPanelAction.md)
- [`UpdateSubscribeButtonAction`](../../YTNodes/classes/UpdateSubscribeButtonAction.md)
- [`AddToPlaylist`](../../YTNodes/classes/AddToPlaylist.md)
- [`Alert`](../../YTNodes/classes/Alert.md)
- [`AlertWithButton`](../../YTNodes/classes/AlertWithButton.md)
- [`AnalyticsMainAppKeyMetrics`](../../YTNodes/classes/AnalyticsMainAppKeyMetrics.md)
@@ -74,6 +78,11 @@
- [`CollaboratorInfoCardContent`](../../YTNodes/classes/CollaboratorInfoCardContent.md)
- [`CollageHeroImage`](../../YTNodes/classes/CollageHeroImage.md)
- [`CollectionThumbnailView`](../../YTNodes/classes/CollectionThumbnailView.md)
- [`AddToPlaylistCommand`](../../YTNodes/classes/AddToPlaylistCommand.md)
- [`CommandExecutorCommand`](../../YTNodes/classes/CommandExecutorCommand.md)
- [`ContinuationCommand`](../../YTNodes/classes/ContinuationCommand.md)
- [`GetKidsBlocklistPickerCommand`](../../YTNodes/classes/GetKidsBlocklistPickerCommand.md)
- [`ShowDialogCommand`](../../YTNodes/classes/ShowDialogCommand.md)
- [`AuthorCommentBadge`](../../YTNodes/classes/AuthorCommentBadge.md)
- [`Comment`](../../YTNodes/classes/Comment.md)
- [`CommentActionButtons`](../../YTNodes/classes/CommentActionButtons.md)
@@ -103,21 +112,45 @@
- [`ConversationBar`](../../YTNodes/classes/ConversationBar.md)
- [`CopyLink`](../../YTNodes/classes/CopyLink.md)
- [`CreatePlaylistDialog`](../../YTNodes/classes/CreatePlaylistDialog.md)
- [`CreatePlaylistDialogFormView`](../../YTNodes/classes/CreatePlaylistDialogFormView.md)
- [`DecoratedAvatarView`](../../YTNodes/classes/DecoratedAvatarView.md)
- [`DecoratedPlayerBar`](../../YTNodes/classes/DecoratedPlayerBar.md)
- [`DefaultPromoPanel`](../../YTNodes/classes/DefaultPromoPanel.md)
- [`DescriptionPreviewView`](../../YTNodes/classes/DescriptionPreviewView.md)
- [`DialogHeaderView`](../../YTNodes/classes/DialogHeaderView.md)
- [`DialogView`](../../YTNodes/classes/DialogView.md)
- [`DidYouMean`](../../YTNodes/classes/DidYouMean.md)
- [`DislikeButtonView`](../../YTNodes/classes/DislikeButtonView.md)
- [`DownloadButton`](../../YTNodes/classes/DownloadButton.md)
- [`Dropdown`](../../YTNodes/classes/Dropdown.md)
- [`DropdownItem`](../../YTNodes/classes/DropdownItem.md)
- [`DropdownView`](../../YTNodes/classes/DropdownView.md)
- [`DynamicTextView`](../../YTNodes/classes/DynamicTextView.md)
- [`Element`](../../YTNodes/classes/Element.md)
- [`EmergencyOnebox`](../../YTNodes/classes/EmergencyOnebox.md)
- [`EmojiPickerCategory`](../../YTNodes/classes/EmojiPickerCategory.md)
- [`EmojiPickerCategoryButton`](../../YTNodes/classes/EmojiPickerCategoryButton.md)
- [`EmojiPickerUpsellCategory`](../../YTNodes/classes/EmojiPickerUpsellCategory.md)
- [`AddToPlaylistServiceEndpoint`](../../YTNodes/classes/AddToPlaylistServiceEndpoint.md)
- [`BrowseEndpoint`](../../YTNodes/classes/BrowseEndpoint.md)
- [`CreateCommentEndpoint`](../../YTNodes/classes/CreateCommentEndpoint.md)
- [`CreatePlaylistServiceEndpoint`](../../YTNodes/classes/CreatePlaylistServiceEndpoint.md)
- [`DeletePlaylistEndpoint`](../../YTNodes/classes/DeletePlaylistEndpoint.md)
- [`FeedbackEndpoint`](../../YTNodes/classes/FeedbackEndpoint.md)
- [`GetAccountsListInnertubeEndpoint`](../../YTNodes/classes/GetAccountsListInnertubeEndpoint.md)
- [`LikeEndpoint`](../../YTNodes/classes/LikeEndpoint.md)
- [`LiveChatItemContextMenuEndpoint`](../../YTNodes/classes/LiveChatItemContextMenuEndpoint.md)
- [`ModifyChannelNotificationPreferenceEndpoint`](../../YTNodes/classes/ModifyChannelNotificationPreferenceEndpoint.md)
- [`PerformCommentActionEndpoint`](../../YTNodes/classes/PerformCommentActionEndpoint.md)
- [`PlaylistEditEndpoint`](../../YTNodes/classes/PlaylistEditEndpoint.md)
- [`ReelWatchEndpoint`](../../YTNodes/classes/ReelWatchEndpoint.md)
- [`SearchEndpoint`](../../YTNodes/classes/SearchEndpoint.md)
- [`ShareEntityServiceEndpoint`](../../YTNodes/classes/ShareEntityServiceEndpoint.md)
- [`SignalServiceEndpoint`](../../YTNodes/classes/SignalServiceEndpoint.md)
- [`SubscribeEndpoint`](../../YTNodes/classes/SubscribeEndpoint.md)
- [`UnsubscribeEndpoint`](../../YTNodes/classes/UnsubscribeEndpoint.md)
- [`WatchEndpoint`](../../YTNodes/classes/WatchEndpoint.md)
- [`WatchNextEndpoint`](../../YTNodes/classes/WatchNextEndpoint.md)
- [`Endscreen`](../../YTNodes/classes/Endscreen.md)
- [`EndscreenElement`](../../YTNodes/classes/EndscreenElement.md)
- [`EndScreenPlaylist`](../../YTNodes/classes/EndScreenPlaylist.md)
@@ -135,6 +168,7 @@
- [`FeedNudge`](../../YTNodes/classes/FeedNudge.md)
- [`FeedTabbedHeader`](../../YTNodes/classes/FeedTabbedHeader.md)
- [`FlexibleActionsView`](../../YTNodes/classes/FlexibleActionsView.md)
- [`FormFooterView`](../../YTNodes/classes/FormFooterView.md)
- [`GameCard`](../../YTNodes/classes/GameCard.md)
- [`GameDetails`](../../YTNodes/classes/GameDetails.md)
- [`Grid`](../../YTNodes/classes/Grid.md)
@@ -178,14 +212,20 @@
- [`DimChatItemAction`](../../YTNodes/classes/DimChatItemAction.md)
- [`LiveChatAutoModMessage`](../../YTNodes/classes/LiveChatAutoModMessage.md)
- [`LiveChatBanner`](../../YTNodes/classes/LiveChatBanner.md)
- [`LiveChatBannerChatSummary`](../../YTNodes/classes/LiveChatBannerChatSummary.md)
- [`LiveChatBannerHeader`](../../YTNodes/classes/LiveChatBannerHeader.md)
- [`LiveChatBannerPoll`](../../YTNodes/classes/LiveChatBannerPoll.md)
- [`LiveChatBannerRedirect`](../../YTNodes/classes/LiveChatBannerRedirect.md)
- [`LiveChatMembershipItem`](../../YTNodes/classes/LiveChatMembershipItem.md)
- [`LiveChatModeChangeMessage`](../../YTNodes/classes/LiveChatModeChangeMessage.md)
- [`LiveChatPaidMessage`](../../YTNodes/classes/LiveChatPaidMessage.md)
- [`LiveChatPaidSticker`](../../YTNodes/classes/LiveChatPaidSticker.md)
- [`LiveChatPlaceholderItem`](../../YTNodes/classes/LiveChatPlaceholderItem.md)
- [`LiveChatProductItem`](../../YTNodes/classes/LiveChatProductItem.md)
- [`LiveChatRestrictedParticipation`](../../YTNodes/classes/LiveChatRestrictedParticipation.md)
- [`LiveChatSponsorshipsGiftPurchaseAnnouncement`](../../YTNodes/classes/LiveChatSponsorshipsGiftPurchaseAnnouncement.md)
- [`LiveChatSponsorshipsGiftRedemptionAnnouncement`](../../YTNodes/classes/LiveChatSponsorshipsGiftRedemptionAnnouncement.md)
- [`LiveChatSponsorshipsHeader`](../../YTNodes/classes/LiveChatSponsorshipsHeader.md)
- [`LiveChatTickerPaidMessageItem`](../../YTNodes/classes/LiveChatTickerPaidMessageItem.md)
- [`LiveChatTickerSponsorItem`](../../YTNodes/classes/LiveChatTickerSponsorItem.md)
- [`PollHeader`](../../YTNodes/classes/PollHeader.md)
@@ -218,6 +258,7 @@
- [`MacroMarkersList`](../../YTNodes/classes/MacroMarkersList.md)
- [`MacroMarkersListItem`](../../YTNodes/classes/MacroMarkersListItem.md)
- [`Menu`](../../YTNodes/classes/Menu.md)
- [`MenuFlexibleItem`](../../YTNodes/classes/MenuFlexibleItem.md)
- [`MenuPopup`](../../YTNodes/classes/MenuPopup.md)
- [`MenuServiceItemDownload`](../../YTNodes/classes/MenuServiceItemDownload.md)
- [`MultiPageMenu`](../../YTNodes/classes/MultiPageMenu.md)
@@ -226,6 +267,7 @@
- [`MusicMultiSelectMenu`](../../YTNodes/classes/MusicMultiSelectMenu.md)
- [`MusicMultiSelectMenuItem`](../../YTNodes/classes/MusicMultiSelectMenuItem.md)
- [`SimpleMenuHeader`](../../YTNodes/classes/SimpleMenuHeader.md)
- [`MenuTitle`](../../YTNodes/classes/MenuTitle.md)
- [`MerchandiseItem`](../../YTNodes/classes/MerchandiseItem.md)
- [`MerchandiseShelf`](../../YTNodes/classes/MerchandiseShelf.md)
- [`Message`](../../YTNodes/classes/Message.md)
@@ -273,9 +315,11 @@
- [`MusicVisualHeader`](../../YTNodes/classes/MusicVisualHeader.md)
- [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md)
- [`Notification`](../../YTNodes/classes/Notification.md)
- [`NotificationAction`](../../YTNodes/classes/NotificationAction.md)
- [`PageHeader`](../../YTNodes/classes/PageHeader.md)
- [`PageHeaderView`](../../YTNodes/classes/PageHeaderView.md)
- [`PageIntroduction`](../../YTNodes/classes/PageIntroduction.md)
- [`PanelFooterView`](../../YTNodes/classes/PanelFooterView.md)
- [`PivotButton`](../../YTNodes/classes/PivotButton.md)
- [`PlayerAnnotationsExpanded`](../../YTNodes/classes/PlayerAnnotationsExpanded.md)
- [`PlayerCaptionsTracklist`](../../YTNodes/classes/PlayerCaptionsTracklist.md)
@@ -288,8 +332,10 @@
- [`PlayerOverflow`](../../YTNodes/classes/PlayerOverflow.md)
- [`PlayerOverlay`](../../YTNodes/classes/PlayerOverlay.md)
- [`PlayerOverlayAutoplay`](../../YTNodes/classes/PlayerOverlayAutoplay.md)
- [`PlayerOverlayVideoDetails`](../../YTNodes/classes/PlayerOverlayVideoDetails.md)
- [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md)
- [`Playlist`](../../YTNodes/classes/Playlist.md)
- [`PlaylistAddToOption`](../../YTNodes/classes/PlaylistAddToOption.md)
- [`PlaylistCustomThumbnail`](../../YTNodes/classes/PlaylistCustomThumbnail.md)
- [`PlaylistHeader`](../../YTNodes/classes/PlaylistHeader.md)
- [`PlaylistInfoCardContent`](../../YTNodes/classes/PlaylistInfoCardContent.md)
@@ -305,6 +351,7 @@
- [`PlaylistVideoThumbnail`](../../YTNodes/classes/PlaylistVideoThumbnail.md)
- [`Poll`](../../YTNodes/classes/Poll.md)
- [`PostMultiImage`](../../YTNodes/classes/PostMultiImage.md)
- [`PremiereTrailerBadge`](../../YTNodes/classes/PremiereTrailerBadge.md)
- [`ProductList`](../../YTNodes/classes/ProductList.md)
- [`ProductListHeader`](../../YTNodes/classes/ProductListHeader.md)
- [`ProductListItem`](../../YTNodes/classes/ProductListItem.md)
@@ -345,6 +392,9 @@
- [`SettingsSidebar`](../../YTNodes/classes/SettingsSidebar.md)
- [`SettingsSwitch`](../../YTNodes/classes/SettingsSwitch.md)
- [`SharedPost`](../../YTNodes/classes/SharedPost.md)
- [`SharePanelHeader`](../../YTNodes/classes/SharePanelHeader.md)
- [`SharePanelTitleV15`](../../YTNodes/classes/SharePanelTitleV15.md)
- [`ShareTarget`](../../YTNodes/classes/ShareTarget.md)
- [`Shelf`](../../YTNodes/classes/Shelf.md)
- [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md)
- [`ShowCustomThumbnail`](../../YTNodes/classes/ShowCustomThumbnail.md)
@@ -360,6 +410,7 @@
- [`SlimVideoMetadata`](../../YTNodes/classes/SlimVideoMetadata.md)
- [`SortFilterHeader`](../../YTNodes/classes/SortFilterHeader.md)
- [`SortFilterSubMenu`](../../YTNodes/classes/SortFilterSubMenu.md)
- [`StartAt`](../../YTNodes/classes/StartAt.md)
- [`StructuredDescriptionContent`](../../YTNodes/classes/StructuredDescriptionContent.md)
- [`StructuredDescriptionPlaylistLockup`](../../YTNodes/classes/StructuredDescriptionPlaylistLockup.md)
- [`SubFeedOption`](../../YTNodes/classes/SubFeedOption.md)
@@ -369,7 +420,9 @@
- [`Tab`](../../YTNodes/classes/Tab.md)
- [`Tabbed`](../../YTNodes/classes/Tabbed.md)
- [`TabbedSearchResults`](../../YTNodes/classes/TabbedSearchResults.md)
- [`TextFieldView`](../../YTNodes/classes/TextFieldView.md)
- [`TextHeader`](../../YTNodes/classes/TextHeader.md)
- [`ThirdPartyShareTargetSection`](../../YTNodes/classes/ThirdPartyShareTargetSection.md)
- [`ThumbnailBadgeView`](../../YTNodes/classes/ThumbnailBadgeView.md)
- [`ThumbnailHoverOverlayView`](../../YTNodes/classes/ThumbnailHoverOverlayView.md)
- [`ThumbnailLandscapePortrait`](../../YTNodes/classes/ThumbnailLandscapePortrait.md)
@@ -404,6 +457,7 @@
- [`TwoColumnBrowseResults`](../../YTNodes/classes/TwoColumnBrowseResults.md)
- [`TwoColumnSearchResults`](../../YTNodes/classes/TwoColumnSearchResults.md)
- [`TwoColumnWatchNextResults`](../../YTNodes/classes/TwoColumnWatchNextResults.md)
- [`UnifiedSharePanel`](../../YTNodes/classes/UnifiedSharePanel.md)
- [`UniversalWatchCard`](../../YTNodes/classes/UniversalWatchCard.md)
- [`UploadTimeFactoid`](../../YTNodes/classes/UploadTimeFactoid.md)
- [`UpsellDialog`](../../YTNodes/classes/UpsellDialog.md)
@@ -421,6 +475,7 @@
- [`VideoOwner`](../../YTNodes/classes/VideoOwner.md)
- [`VideoPrimaryInfo`](../../YTNodes/classes/VideoPrimaryInfo.md)
- [`VideoSecondaryInfo`](../../YTNodes/classes/VideoSecondaryInfo.md)
- [`VideoViewCount`](../../YTNodes/classes/VideoViewCount.md)
- [`ViewCountFactoid`](../../YTNodes/classes/ViewCountFactoid.md)
- [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)
- [`WatchCardHeroVideo`](../../YTNodes/classes/WatchCardHeroVideo.md)
@@ -459,7 +514,7 @@
#### Defined in
[src/parser/helpers.ts:10](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L10)
[src/parser/helpers.ts:10](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L10)
## Properties
@@ -469,7 +524,7 @@
#### Defined in
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L8)
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L8)
***
@@ -479,7 +534,7 @@
#### Defined in
[src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L7)
[src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L7)
## Methods
@@ -499,13 +554,21 @@ Cast to one of the given types.
• ...**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
#### Defined in
[src/parser/helpers.ts:35](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L35)
[src/parser/helpers.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L38)
***
@@ -535,7 +598,7 @@ Whether the node has the key
#### Defined in
[src/parser/helpers.ts:47](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L47)
[src/parser/helpers.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L50)
***
@@ -565,7 +628,7 @@ whether the node is of the given type
#### Defined in
[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L28)
[src/parser/helpers.ts:28](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L28)
***
@@ -599,4 +662,4 @@ If the node does not have the key
#### Defined in
[src/parser/helpers.ts:57](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L57)
[src/parser/helpers.ts:60](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/helpers.ts#L60)