chore(docs): Update API ref [skip ci]

This commit is contained in:
Luan
2024-11-25 03:25:27 -03:00
parent 4729016fb9
commit fcd65b4dba
756 changed files with 7232 additions and 7009 deletions

View File

@@ -16,4 +16,4 @@
## Defined in
[src/parser/parser.ts:216](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L216)
[src/parser/parser.ts:215](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L215)

View File

@@ -16,4 +16,4 @@
## Defined in
[src/parser/parser.ts:780](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L780)
[src/parser/parser.ts:779](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L779)

View File

@@ -16,4 +16,4 @@
## Defined in
[src/parser/parser.ts:744](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L744)
[src/parser/parser.ts:743](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L743)

View File

@@ -10,4 +10,4 @@
## Defined in
[src/parser/parser.ts:221](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L221)
[src/parser/parser.ts:220](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L220)

View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:200](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L200)
[src/parser/parser.ts:199](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L199)

View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:212](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L212)
[src/parser/parser.ts:211](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L211)

View File

@@ -34,7 +34,7 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:603](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L603)
[src/parser/parser.ts:602](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L602)
## parse(data, requireArray, validTypes)
@@ -60,7 +60,7 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:604](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L604)
[src/parser/parser.ts:603](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L603)
## parse(data, requireArray, validTypes)
@@ -84,4 +84,4 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:605](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L605)
[src/parser/parser.ts:604](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L604)

View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:730](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L730)
[src/parser/parser.ts:729](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L729)

View File

@@ -30,7 +30,7 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:576](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L576)
[src/parser/parser.ts:575](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L575)
## parseArray(data, validType)
@@ -52,7 +52,7 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:577](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L577)
[src/parser/parser.ts:576](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L576)
## parseArray(data)
@@ -68,4 +68,4 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:578](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L578)
[src/parser/parser.ts:577](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L577)

View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:690](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L690)
[src/parser/parser.ts:689](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L689)

View File

@@ -20,4 +20,4 @@ A YTNode instance if parsing is successful, undefined otherwise
## Defined in
[src/parser/parser.ts:638](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L638)
[src/parser/parser.ts:637](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L637)

View File

@@ -20,4 +20,4 @@ An observed array of parsed YTNodes
## Defined in
[src/parser/parser.ts:674](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L674)
[src/parser/parser.ts:673](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L673)

View File

@@ -16,4 +16,4 @@
## Defined in
[src/parser/parser.ts:740](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L740)
[src/parser/parser.ts:739](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L739)

View File

@@ -30,7 +30,7 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:510](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L510)
[src/parser/parser.ts:509](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L509)
## parseItem(data, validTypes)
@@ -52,7 +52,7 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:511](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L511)
[src/parser/parser.ts:510](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L510)
## parseItem(data)
@@ -68,4 +68,4 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:512](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L512)
[src/parser/parser.ts:511](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L511)

View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:696](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L696)
[src/parser/parser.ts:695](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L695)

View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:717](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L717)
[src/parser/parser.ts:716](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L716)

View File

@@ -22,4 +22,4 @@ Raw data.
## Defined in
[src/parser/parser.ts:229](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L229)
[src/parser/parser.ts:228](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L228)

View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:194](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L194)
[src/parser/parser.ts:193](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L193)

View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:161](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L161)
[src/parser/parser.ts:160](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L160)

View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:190](https://github.com/LuanRT/YouTube.js/blob/cf09f7bab14fcca99e1f3ae428c7337fea58cfa5/src/parser/parser.ts#L190)
[src/parser/parser.ts:189](https://github.com/LuanRT/YouTube.js/blob/4729016fb98e7045ee4043857be7eef780c01e35/src/parser/parser.ts#L189)