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

chore(docs): update

Browse Source
This commit is contained in:
LuanRT
2026-05-07 14:38:16 -03:00
parent faaf5fc5c1
commit 03cb4d6801
859 changed files with 11610 additions and 9101 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/api/youtubei.js/namespaces/Helpers/classes/Maybe.md
View File

@@ -2,7 +2,7 @@
# Class: Maybe
Defined in: [src/parser/helpers.ts:64](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L64)
Defined in: [src/parser/helpers.ts:64](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L64)
A wrapper class that provides type-safe access to a value.
@@ -12,7 +12,7 @@ A wrapper class that provides type-safe access to a value.
> **new Maybe**(`value`): `Maybe`
Defined in: [src/parser/helpers.ts:67](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L67)
Defined in: [src/parser/helpers.ts:67](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L67)
#### Parameters
@@ -32,7 +32,7 @@ Defined in: [src/parser/helpers.ts:67](https://github.com/LuanRT/YouTube.js/blob
> **get** **typeof**(): `"string"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"symbol"` \| `"undefined"` \| `"object"` \| `"function"`
Defined in: [src/parser/helpers.ts:82](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L82)
Defined in: [src/parser/helpers.ts:82](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L82)
##### Returns
@@ -44,7 +44,7 @@ Defined in: [src/parser/helpers.ts:82](https://github.com/LuanRT/YouTube.js/blob
> **any**(): `any`
Defined in: [src/parser/helpers.ts:278](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L278)
Defined in: [src/parser/helpers.ts:278](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L278)
#### Returns
@@ -60,7 +60,7 @@ This call is not meant to be used outside of debugging. Please use the specific
> **array**(): `any`[]
Defined in: [src/parser/helpers.ts:166](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L166)
Defined in: [src/parser/helpers.ts:166](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L166)
Get the value as an array.
@@ -80,7 +80,7 @@ If the value is not an array.
> **arrayOfMaybe**(): `Maybe`[]
Defined in: [src/parser/helpers.ts:178](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L178)
Defined in: [src/parser/helpers.ts:178](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L178)
More typesafe variant of [Maybe#array](#array).
@@ -100,7 +100,7 @@ If the value is not an array
> **bigint**(): `bigint`
Defined in: [src/parser/helpers.ts:102](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L102)
Defined in: [src/parser/helpers.ts:102](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L102)
#### Returns
@@ -112,7 +112,7 @@ Defined in: [src/parser/helpers.ts:102](https://github.com/LuanRT/YouTube.js/blo
> **boolean**(): `boolean`
Defined in: [src/parser/helpers.ts:110](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L110)
Defined in: [src/parser/helpers.ts:110](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L110)
#### Returns
@@ -124,7 +124,7 @@ Defined in: [src/parser/helpers.ts:110](https://github.com/LuanRT/YouTube.js/blo
> **function**(): `Function`
Defined in: [src/parser/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L153)
Defined in: [src/parser/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L153)
#### Returns
@@ -136,7 +136,7 @@ Defined in: [src/parser/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blo
> **instanceof**\<`T`\>(`type`): `T`
Defined in: [src/parser/helpers.ts:289](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L289)
Defined in: [src/parser/helpers.ts:289](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L289)
Get the node as an instance of the given class.
@@ -170,7 +170,7 @@ If the node is not of the given type.
> **isArray**(): `boolean`
Defined in: [src/parser/helpers.ts:194](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L194)
Defined in: [src/parser/helpers.ts:194](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L194)
Check whether the value is an array.
@@ -186,7 +186,7 @@ whether the value is an array.
> **isBigint**(): `boolean`
Defined in: [src/parser/helpers.ts:106](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L106)
Defined in: [src/parser/helpers.ts:106](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L106)
#### Returns
@@ -198,7 +198,7 @@ Defined in: [src/parser/helpers.ts:106](https://github.com/LuanRT/YouTube.js/blo
> **isBoolean**(): `boolean`
Defined in: [src/parser/helpers.ts:114](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L114)
Defined in: [src/parser/helpers.ts:114](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L114)
#### Returns
@@ -210,7 +210,7 @@ Defined in: [src/parser/helpers.ts:114](https://github.com/LuanRT/YouTube.js/blo
> **isFunction**(): `boolean`
Defined in: [src/parser/helpers.ts:157](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L157)
Defined in: [src/parser/helpers.ts:157](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L157)
#### Returns
@@ -222,7 +222,7 @@ Defined in: [src/parser/helpers.ts:157](https://github.com/LuanRT/YouTube.js/blo
> **isInstanceof**\<`T`\>(`type`): `this is Maybe & T`
Defined in: [src/parser/helpers.ts:301](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L301)
Defined in: [src/parser/helpers.ts:301](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L301)
Check if the node is an instance of the given class.
@@ -252,7 +252,7 @@ Whether the node is an instance of the given type.
> **isNode**(): `boolean`
Defined in: [src/parser/helpers.ts:214](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L214)
Defined in: [src/parser/helpers.ts:214](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L214)
Check if the value is a YTNode.
@@ -268,7 +268,7 @@ Whether the value is a YTNode.
> **isNodeOfType**\<`T`, `K`\>(...`types`): `boolean`
Defined in: [src/parser/helpers.ts:233](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L233)
Defined in: [src/parser/helpers.ts:233](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L233)
Check if the value is a YTNode of the given type.
@@ -302,7 +302,7 @@ Whether the value is a YTNode of the given type.
> **isNull**(): `boolean`
Defined in: [src/parser/helpers.ts:140](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L140)
Defined in: [src/parser/helpers.ts:140](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L140)
#### Returns
@@ -314,7 +314,7 @@ Defined in: [src/parser/helpers.ts:140](https://github.com/LuanRT/YouTube.js/blo
> **isNumber**(): `boolean`
Defined in: [src/parser/helpers.ts:98](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L98)
Defined in: [src/parser/helpers.ts:98](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L98)
#### Returns
@@ -326,7 +326,7 @@ Defined in: [src/parser/helpers.ts:98](https://github.com/LuanRT/YouTube.js/blob
> **isObject**(): `boolean`
Defined in: [src/parser/helpers.ts:148](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L148)
Defined in: [src/parser/helpers.ts:148](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L148)
#### Returns
@@ -338,7 +338,7 @@ Defined in: [src/parser/helpers.ts:148](https://github.com/LuanRT/YouTube.js/blo
> **isObserved**(): `any`
Defined in: [src/parser/helpers.ts:251](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L251)
Defined in: [src/parser/helpers.ts:251](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L251)
Check if the value is an ObservedArray.
@@ -352,7 +352,7 @@ Check if the value is an ObservedArray.
> **isParsed**(): `boolean`
Defined in: [src/parser/helpers.ts:270](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L270)
Defined in: [src/parser/helpers.ts:270](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L270)
Is the result a SuperParsedResult?
@@ -366,7 +366,7 @@ Is the result a SuperParsedResult?
> **isString**(): `boolean`
Defined in: [src/parser/helpers.ts:90](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L90)
Defined in: [src/parser/helpers.ts:90](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L90)
#### Returns
@@ -378,7 +378,7 @@ Defined in: [src/parser/helpers.ts:90](https://github.com/LuanRT/YouTube.js/blob
> **isSymbol**(): `boolean`
Defined in: [src/parser/helpers.ts:122](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L122)
Defined in: [src/parser/helpers.ts:122](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L122)
#### Returns
@@ -390,7 +390,7 @@ Defined in: [src/parser/helpers.ts:122](https://github.com/LuanRT/YouTube.js/blo
> **isUndefined**(): `boolean`
Defined in: [src/parser/helpers.ts:130](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L130)
Defined in: [src/parser/helpers.ts:130](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L130)
#### Returns
@@ -402,7 +402,7 @@ Defined in: [src/parser/helpers.ts:130](https://github.com/LuanRT/YouTube.js/blo
> **node**(): [`YTNode`](YTNode.md)
Defined in: [src/parser/helpers.ts:203](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L203)
Defined in: [src/parser/helpers.ts:203](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L203)
Get the value as a YTNode.
@@ -422,7 +422,7 @@ If the value is not a YTNode.
> **nodeOfType**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
Defined in: [src/parser/helpers.ts:224](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L224)
Defined in: [src/parser/helpers.ts:224](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L224)
Get the value as a YTNode of the given type.
@@ -460,7 +460,7 @@ If the node is not of the given type.
> **null**(): `null`
Defined in: [src/parser/helpers.ts:134](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L134)
Defined in: [src/parser/helpers.ts:134](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L134)
#### Returns
@@ -472,7 +472,7 @@ Defined in: [src/parser/helpers.ts:134](https://github.com/LuanRT/YouTube.js/blo
> **number**(): `number`
Defined in: [src/parser/helpers.ts:94](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L94)
Defined in: [src/parser/helpers.ts:94](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L94)
#### Returns
@@ -484,7 +484,7 @@ Defined in: [src/parser/helpers.ts:94](https://github.com/LuanRT/YouTube.js/blob
> **object**(): `object`
Defined in: [src/parser/helpers.ts:144](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L144)
Defined in: [src/parser/helpers.ts:144](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L144)
#### Returns
@@ -496,7 +496,7 @@ Defined in: [src/parser/helpers.ts:144](https://github.com/LuanRT/YouTube.js/blo
> **observed**(): [`ObservedArray`](../type-aliases/ObservedArray.md)\<[`YTNode`](YTNode.md)\>
Defined in: [src/parser/helpers.ts:241](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L241)
Defined in: [src/parser/helpers.ts:241](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L241)
Get the value as an ObservedArray.
@@ -512,7 +512,7 @@ the value of the Maybe as a ObservedArray.
> **parsed**(): [`SuperParsedResult`](SuperParsedResult.md)
Defined in: [src/parser/helpers.ts:260](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L260)
Defined in: [src/parser/helpers.ts:260](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L260)
Get the value of the Maybe as a SuperParsedResult.
@@ -532,7 +532,7 @@ If the value is not a SuperParsedResult.
> **string**(): `string`
Defined in: [src/parser/helpers.ts:86](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L86)
Defined in: [src/parser/helpers.ts:86](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L86)
#### Returns
@@ -544,7 +544,7 @@ Defined in: [src/parser/helpers.ts:86](https://github.com/LuanRT/YouTube.js/blob
> **symbol**(): `symbol`
Defined in: [src/parser/helpers.ts:118](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L118)
Defined in: [src/parser/helpers.ts:118](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L118)
#### Returns
@@ -556,7 +556,7 @@ Defined in: [src/parser/helpers.ts:118](https://github.com/LuanRT/YouTube.js/blo
> **undefined**(): `undefined`
Defined in: [src/parser/helpers.ts:126](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L126)
Defined in: [src/parser/helpers.ts:126](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L126)
#### Returns

34
docs/api/youtubei.js/namespaces/Helpers/classes/Memo.md
View File

@@ -2,7 +2,7 @@
# Class: Memo
Defined in: [src/parser/helpers.ts:502](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L502)
Defined in: [src/parser/helpers.ts:502](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L502)
## Extends
@@ -40,7 +40,7 @@ Defined in: node\_modules/typescript/lib/lib.es2015.collection.d.ts:49
##### iterable?
`Iterable`\<readonly \[`string`, [`YTNode`](YTNode.md)[]\]\> | `null`
`Iterable`\<readonly \[`string`, [`YTNode`](YTNode.md)[]\], `any`, `any`\> | `null`
#### Returns
@@ -94,15 +94,15 @@ Defined in: node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:319
### \[iterator\]()
> **\[iterator\]**(): `IterableIterator`\<\[`string`, [`YTNode`](YTNode.md)[]\]\>
> **\[iterator\]**(): `MapIterator`\<\[`string`, [`YTNode`](YTNode.md)[]\]\>
Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:119
Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:143
Returns an iterable of entries in the map.
#### Returns
`IterableIterator`\<\[`string`, [`YTNode`](YTNode.md)[]\]\>
`MapIterator`\<\[`string`, [`YTNode`](YTNode.md)[]\]\>
#### Inherited from
@@ -152,15 +152,15 @@ true if an element in the Map existed and has been removed, or false if the elem
### entries()
> **entries**(): `IterableIterator`\<\[`string`, [`YTNode`](YTNode.md)[]\]\>
> **entries**(): `MapIterator`\<\[`string`, [`YTNode`](YTNode.md)[]\]\>
Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:124
Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:148
Returns an iterable of key, value pairs for every entry in the map.
#### Returns
`IterableIterator`\<\[`string`, [`YTNode`](YTNode.md)[]\]\>
`MapIterator`\<\[`string`, [`YTNode`](YTNode.md)[]\]\>
#### Inherited from
@@ -228,7 +228,7 @@ Returns the element associated with the specified key. If no element is associat
> **getType**\<`T`, `K`\>(`types`): [`ObservedArray`](../type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\>
Defined in: [src/parser/helpers.ts:503](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L503)
Defined in: [src/parser/helpers.ts:503](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L503)
##### Type Parameters
@@ -254,7 +254,7 @@ Defined in: [src/parser/helpers.ts:503](https://github.com/LuanRT/YouTube.js/blo
> **getType**\<`T`, `K`\>(...`types`): [`ObservedArray`](../type-aliases/ObservedArray.md)\<`InstanceType`\<`K`\[`number`\]\>\>
Defined in: [src/parser/helpers.ts:504](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L504)
Defined in: [src/parser/helpers.ts:504](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L504)
##### Type Parameters
@@ -304,15 +304,15 @@ boolean indicating whether an element with the specified key exists or not.
### keys()
> **keys**(): `IterableIterator`\<`string`\>
> **keys**(): `MapIterator`\<`string`\>
Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:129
Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:153
Returns an iterable of keys in the map
#### Returns
`IterableIterator`\<`string`\>
`MapIterator`\<`string`\>
#### Inherited from
@@ -350,15 +350,15 @@ Adds a new element with a specified key and value to the Map. If an element with
### values()
> **values**(): `IterableIterator`\<[`YTNode`](YTNode.md)[]\>
> **values**(): `MapIterator`\<[`YTNode`](YTNode.md)[]\>
Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:134
Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:158
Returns an iterable of values in the map
#### Returns
`IterableIterator`\<[`YTNode`](YTNode.md)[]\>
`MapIterator`\<[`YTNode`](YTNode.md)[]\>
#### Inherited from
@@ -370,7 +370,7 @@ Returns an iterable of values in the map
> `static` **groupBy**\<`K`, `T`\>(`items`, `keySelector`): `Map`\<`K`, `T`[]\>
Defined in: node\_modules/typescript/lib/lib.esnext.collection.d.ts:25
Defined in: node\_modules/typescript/lib/lib.es2024.collection.d.ts:25
Groups members of an iterable according to the return value of the passed callback.

14
docs/api/youtubei.js/namespaces/Helpers/classes/SuperParsedResult.md
View File

@@ -2,7 +2,7 @@
# Class: SuperParsedResult\<T\>
Defined in: [src/parser/helpers.ts:318](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L318)
Defined in: [src/parser/helpers.ts:318](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L318)
Represents a parsed response in an unknown state. Either a YTNode or a YTNode[] or null.
@@ -18,7 +18,7 @@ Represents a parsed response in an unknown state. Either a YTNode or a YTNode[]
> **new SuperParsedResult**\<`T`\>(`result`): `SuperParsedResult`\<`T`\>
Defined in: [src/parser/helpers.ts:321](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L321)
Defined in: [src/parser/helpers.ts:321](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L321)
#### Parameters
@@ -38,7 +38,7 @@ Defined in: [src/parser/helpers.ts:321](https://github.com/LuanRT/YouTube.js/blo
> **get** **is\_array**(): `boolean`
Defined in: [src/parser/helpers.ts:328](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L328)
Defined in: [src/parser/helpers.ts:328](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L328)
##### Returns
@@ -52,7 +52,7 @@ Defined in: [src/parser/helpers.ts:328](https://github.com/LuanRT/YouTube.js/blo
> **get** **is\_node**(): `boolean`
Defined in: [src/parser/helpers.ts:331](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L331)
Defined in: [src/parser/helpers.ts:331](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L331)
##### Returns
@@ -66,7 +66,7 @@ Defined in: [src/parser/helpers.ts:331](https://github.com/LuanRT/YouTube.js/blo
> **get** **is\_null**(): `boolean`
Defined in: [src/parser/helpers.ts:325](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L325)
Defined in: [src/parser/helpers.ts:325](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L325)
##### Returns
@@ -78,7 +78,7 @@ Defined in: [src/parser/helpers.ts:325](https://github.com/LuanRT/YouTube.js/blo
> **array**(): [`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\>
Defined in: [src/parser/helpers.ts:335](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L335)
Defined in: [src/parser/helpers.ts:335](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L335)
#### Returns
@@ -90,7 +90,7 @@ Defined in: [src/parser/helpers.ts:335](https://github.com/LuanRT/YouTube.js/blo
> **item**(): `T`
Defined in: [src/parser/helpers.ts:342](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L342)
Defined in: [src/parser/helpers.ts:342](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L342)
#### Returns

24
docs/api/youtubei.js/namespaces/Helpers/classes/YTNode.md
View File

@@ -2,7 +2,7 @@
# Class: YTNode
Defined in: [src/parser/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L6)
Defined in: [src/parser/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L6)
## Extended by
@@ -102,6 +102,7 @@ Defined in: [src/parser/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/
- [`GetKidsBlocklistPickerCommand`](../../YTNodes/classes/GetKidsBlocklistPickerCommand.md)
- [`RunAttestationCommand`](../../YTNodes/classes/RunAttestationCommand.md)
- [`ShowDialogCommand`](../../YTNodes/classes/ShowDialogCommand.md)
- [`ShowSheetCommand`](../../YTNodes/classes/ShowSheetCommand.md)
- [`UpdateEngagementPanelContentCommand`](../../YTNodes/classes/UpdateEngagementPanelContentCommand.md)
- [`AuthorCommentBadge`](../../YTNodes/classes/AuthorCommentBadge.md)
- [`CommentActionButtons`](../../YTNodes/classes/CommentActionButtons.md)
@@ -145,6 +146,7 @@ Defined in: [src/parser/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/
- [`DismissableDialog`](../../YTNodes/classes/DismissableDialog.md)
- [`DismissableDialogContentSection`](../../YTNodes/classes/DismissableDialogContentSection.md)
- [`DownloadButton`](../../YTNodes/classes/DownloadButton.md)
- [`DownloadListItemView`](../../YTNodes/classes/DownloadListItemView.md)
- [`Dropdown`](../../YTNodes/classes/Dropdown.md)
- [`DropdownItem`](../../YTNodes/classes/DropdownItem.md)
- [`DropdownView`](../../YTNodes/classes/DropdownView.md)
@@ -365,10 +367,12 @@ Defined in: [src/parser/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/
- [`OpenOnePickAddVideoModalCommand`](../../YTNodes/classes/OpenOnePickAddVideoModalCommand.md)
- [`PageHeader`](../../YTNodes/classes/PageHeader.md)
- [`PageHeaderView`](../../YTNodes/classes/PageHeaderView.md)
- [`PageIndicatorView`](../../YTNodes/classes/PageIndicatorView.md)
- [`PageIntroduction`](../../YTNodes/classes/PageIntroduction.md)
- [`PanelFooterView`](../../YTNodes/classes/PanelFooterView.md)
- [`PivotButton`](../../YTNodes/classes/PivotButton.md)
- [`PlayerAnnotationsExpanded`](../../YTNodes/classes/PlayerAnnotationsExpanded.md)
- [`PlayerCaptchaView`](../../YTNodes/classes/PlayerCaptchaView.md)
- [`PlayerCaptionsTracklist`](../../YTNodes/classes/PlayerCaptionsTracklist.md)
- [`PlayerControlsOverlay`](../../YTNodes/classes/PlayerControlsOverlay.md)
- [`PlayerErrorMessage`](../../YTNodes/classes/PlayerErrorMessage.md)
@@ -444,6 +448,7 @@ Defined in: [src/parser/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/
- [`SharePanelHeader`](../../YTNodes/classes/SharePanelHeader.md)
- [`SharePanelTitleV15`](../../YTNodes/classes/SharePanelTitleV15.md)
- [`ShareTarget`](../../YTNodes/classes/ShareTarget.md)
- [`SheetView`](../../YTNodes/classes/SheetView.md)
- [`Shelf`](../../YTNodes/classes/Shelf.md)
- [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md)
- [`ShowCustomThumbnail`](../../YTNodes/classes/ShowCustomThumbnail.md)
@@ -492,6 +497,7 @@ Defined in: [src/parser/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/
- [`ThumbnailOverlayResumePlayback`](../../YTNodes/classes/ThumbnailOverlayResumePlayback.md)
- [`ThumbnailOverlaySidePanel`](../../YTNodes/classes/ThumbnailOverlaySidePanel.md)
- [`ThumbnailOverlayTimeStatus`](../../YTNodes/classes/ThumbnailOverlayTimeStatus.md)
- [`ThumbnailOverlayTitleView`](../../YTNodes/classes/ThumbnailOverlayTitleView.md)
- [`ThumbnailOverlayToggleButton`](../../YTNodes/classes/ThumbnailOverlayToggleButton.md)
- [`ThumbnailView`](../../YTNodes/classes/ThumbnailView.md)
- [`TimedMarkerDecoration`](../../YTNodes/classes/TimedMarkerDecoration.md)
@@ -531,6 +537,8 @@ Defined in: [src/parser/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/
- [`VideoOwner`](../../YTNodes/classes/VideoOwner.md)
- [`VideoPrimaryInfo`](../../YTNodes/classes/VideoPrimaryInfo.md)
- [`VideoSecondaryInfo`](../../YTNodes/classes/VideoSecondaryInfo.md)
- [`VideoSummaryContentView`](../../YTNodes/classes/VideoSummaryContentView.md)
- [`VideoSummaryParagraphView`](../../YTNodes/classes/VideoSummaryParagraphView.md)
- [`VideoViewCount`](../../YTNodes/classes/VideoViewCount.md)
- [`ViewCountFactoid`](../../YTNodes/classes/ViewCountFactoid.md)
- [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)
@@ -552,7 +560,7 @@ Defined in: [src/parser/helpers.ts:6](https://github.com/LuanRT/YouTube.js/blob/
> **new YTNode**(): `YTNode`
Defined in: [src/parser/helpers.ts:10](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L10)
Defined in: [src/parser/helpers.ts:10](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L10)
#### Returns
@@ -564,7 +572,7 @@ Defined in: [src/parser/helpers.ts:10](https://github.com/LuanRT/YouTube.js/blob
> `readonly` **type**: `string`
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L8)
Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L8)
***
@@ -572,7 +580,7 @@ Defined in: [src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/
> `readonly` `static` **type**: `string` = `'YTNode'`
Defined in: [src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L7)
Defined in: [src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L7)
## Methods
@@ -580,7 +588,7 @@ Defined in: [src/parser/helpers.ts:7](https://github.com/LuanRT/YouTube.js/blob/
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L29)
Defined in: [src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L29)
Cast to one of the given types.
@@ -618,7 +626,7 @@ If the node is not of the given type
> **hasKey**\<`T`, `R`\>(`key`): `this is YTNode & { [k in string]: R }`
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L41)
Defined in: [src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L41)
Check for a key without asserting the type.
@@ -652,7 +660,7 @@ Whether the node has the key
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L19)
Defined in: [src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L19)
Check if the node is of the given type.
@@ -686,7 +694,7 @@ whether the node is of the given type
> **key**\<`T`, `R`\>(`key`): [`Maybe`](Maybe.md)
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/0733f60b57877f6b8b87dfd5cc6195b5085f5c09/src/parser/helpers.ts#L51)
Defined in: [src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/helpers.ts#L51)
Assert that the node has the given key and return it.