chore: update docs

This commit is contained in:
Luan
2024-10-28 16:07:35 -03:00
parent 31d1caf06a
commit dba0be7bc8
777 changed files with 7327 additions and 6819 deletions

View File

@@ -18,7 +18,7 @@
#### Defined in
[src/parser/helpers.ts:69](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L69)
[src/parser/helpers.ts:69](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L69)
## Accessors
@@ -32,7 +32,7 @@
#### Defined in
[src/parser/helpers.ts:87](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L87)
[src/parser/helpers.ts:87](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L87)
## Methods
@@ -50,7 +50,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/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L283)
[src/parser/helpers.ts:283](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L283)
***
@@ -72,7 +72,7 @@ If the value is not an array.
#### Defined in
[src/parser/helpers.ts:171](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L171)
[src/parser/helpers.ts:171](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L171)
***
@@ -94,7 +94,7 @@ If the value is not an array
#### Defined in
[src/parser/helpers.ts:183](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L183)
[src/parser/helpers.ts:183](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L183)
***
@@ -108,7 +108,7 @@ If the value is not an array
#### Defined in
[src/parser/helpers.ts:107](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L107)
[src/parser/helpers.ts:107](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L107)
***
@@ -122,7 +122,7 @@ If the value is not an array
#### Defined in
[src/parser/helpers.ts:115](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L115)
[src/parser/helpers.ts:115](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L115)
***
@@ -136,7 +136,7 @@ If the value is not an array
#### Defined in
[src/parser/helpers.ts:158](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L158)
[src/parser/helpers.ts:158](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L158)
***
@@ -168,7 +168,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:294](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L294)
[src/parser/helpers.ts:294](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L294)
***
@@ -186,7 +186,7 @@ whether the value is an array.
#### Defined in
[src/parser/helpers.ts:199](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L199)
[src/parser/helpers.ts:199](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L199)
***
@@ -200,7 +200,7 @@ whether the value is an array.
#### Defined in
[src/parser/helpers.ts:111](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L111)
[src/parser/helpers.ts:111](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L111)
***
@@ -214,7 +214,7 @@ whether the value is an array.
#### Defined in
[src/parser/helpers.ts:119](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L119)
[src/parser/helpers.ts:119](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L119)
***
@@ -228,7 +228,7 @@ whether the value is an array.
#### Defined in
[src/parser/helpers.ts:162](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L162)
[src/parser/helpers.ts:162](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L162)
***
@@ -256,7 +256,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/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L306)
[src/parser/helpers.ts:306](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L306)
***
@@ -274,7 +274,7 @@ Whether the value is a YTNode.
#### Defined in
[src/parser/helpers.ts:219](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L219)
[src/parser/helpers.ts:219](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L219)
***
@@ -304,7 +304,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/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L238)
[src/parser/helpers.ts:238](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L238)
***
@@ -318,7 +318,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/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L145)
[src/parser/helpers.ts:145](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L145)
***
@@ -332,7 +332,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/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L103)
[src/parser/helpers.ts:103](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L103)
***
@@ -346,7 +346,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/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L153)
[src/parser/helpers.ts:153](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L153)
***
@@ -362,7 +362,7 @@ Check if the value is an ObservedArray.
#### Defined in
[src/parser/helpers.ts:256](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L256)
[src/parser/helpers.ts:256](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L256)
***
@@ -378,7 +378,7 @@ Is the result a SuperParsedResult?
#### Defined in
[src/parser/helpers.ts:275](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L275)
[src/parser/helpers.ts:275](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L275)
***
@@ -392,7 +392,7 @@ Is the result a SuperParsedResult?
#### Defined in
[src/parser/helpers.ts:95](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L95)
[src/parser/helpers.ts:95](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L95)
***
@@ -406,7 +406,7 @@ Is the result a SuperParsedResult?
#### Defined in
[src/parser/helpers.ts:127](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L127)
[src/parser/helpers.ts:127](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L127)
***
@@ -420,7 +420,7 @@ Is the result a SuperParsedResult?
#### Defined in
[src/parser/helpers.ts:135](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L135)
[src/parser/helpers.ts:135](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L135)
***
@@ -442,7 +442,7 @@ If the value is not a YTNode.
#### Defined in
[src/parser/helpers.ts:208](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L208)
[src/parser/helpers.ts:208](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L208)
***
@@ -476,7 +476,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:229](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L229)
[src/parser/helpers.ts:229](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L229)
***
@@ -490,7 +490,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:139](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L139)
[src/parser/helpers.ts:139](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L139)
***
@@ -504,7 +504,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:99](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L99)
[src/parser/helpers.ts:99](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L99)
***
@@ -518,7 +518,7 @@ If the node is not of the given type.
#### Defined in
[src/parser/helpers.ts:149](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L149)
[src/parser/helpers.ts:149](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L149)
***
@@ -536,7 +536,7 @@ the value of the Maybe as a ObservedArray.
#### Defined in
[src/parser/helpers.ts:246](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L246)
[src/parser/helpers.ts:246](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L246)
***
@@ -558,7 +558,7 @@ If the value is not a SuperParsedResult.
#### Defined in
[src/parser/helpers.ts:265](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L265)
[src/parser/helpers.ts:265](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L265)
***
@@ -572,7 +572,7 @@ If the value is not a SuperParsedResult.
#### Defined in
[src/parser/helpers.ts:91](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L91)
[src/parser/helpers.ts:91](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L91)
***
@@ -586,7 +586,7 @@ If the value is not a SuperParsedResult.
#### Defined in
[src/parser/helpers.ts:123](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L123)
[src/parser/helpers.ts:123](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L123)
***
@@ -600,4 +600,4 @@ If the value is not a SuperParsedResult.
#### Defined in
[src/parser/helpers.ts:131](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L131)
[src/parser/helpers.ts:131](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/helpers.ts#L131)