jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-19 12:31:17 +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

2
docs/api/namespaces/Parser/README.md
View File

@@ -21,6 +21,8 @@
- [parseActions](functions/parseActions.md)
- [parseArray](functions/parseArray.md)
- [parseC](functions/parseC.md)
- [parseCommand](functions/parseCommand.md)
- [parseCommands](functions/parseCommands.md)
- [parseFormats](functions/parseFormats.md)
- [parseItem](functions/parseItem.md)
- [parseLC](functions/parseLC.md)

2
docs/api/namespaces/Parser/functions/addRuntimeParser.md
View File

@@ -16,4 +16,4 @@
## Defined in
[src/parser/parser.ts:209](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L209)
[src/parser/parser.ts:216](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L216)

2
docs/api/namespaces/Parser/functions/applyCommentsMutations.md
View File

@@ -16,4 +16,4 @@
## Defined in
[src/parser/parser.ts:720](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L720)
[src/parser/parser.ts:780](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L780)

2
docs/api/namespaces/Parser/functions/applyMutations.md
View File

@@ -16,4 +16,4 @@
## Defined in
[src/parser/parser.ts:684](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L684)
[src/parser/parser.ts:744](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L744)

2
docs/api/namespaces/Parser/functions/getDynamicParsers.md
View File

@@ -10,4 +10,4 @@
## Defined in
[src/parser/parser.ts:214](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L214)
[src/parser/parser.ts:221](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L221)

2
docs/api/namespaces/Parser/functions/getParserByName.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:193](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L193)
[src/parser/parser.ts:200](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L200)

2
docs/api/namespaces/Parser/functions/hasParser.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:205](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L205)
[src/parser/parser.ts:212](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L212)

6
docs/api/namespaces/Parser/functions/parse.md
View File

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

2
docs/api/namespaces/Parser/functions/parseActions.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:670](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L670)
[src/parser/parser.ts:730](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L730)

6
docs/api/namespaces/Parser/functions/parseArray.md
View File

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

2
docs/api/namespaces/Parser/functions/parseC.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:630](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L630)
[src/parser/parser.ts:690](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L690)

23
docs/api/namespaces/Parser/functions/parseCommand.md Normal file
View File

@@ -0,0 +1,23 @@
[youtubei.js](../../../README.md) / [Parser](../README.md) / parseCommand
# Function: parseCommand()
> **parseCommand**(`data`): [`YTNode`](../../Helpers/classes/YTNode.md) \| `undefined`
Parses an InnerTube command and returns a YTNode instance if applicable.
## Parameters
• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
The raw node data to parse
## Returns
[`YTNode`](../../Helpers/classes/YTNode.md) \| `undefined`
A YTNode instance if parsing is successful, undefined otherwise
## Defined in
[src/parser/parser.ts:638](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L638)

23
docs/api/namespaces/Parser/functions/parseCommands.md Normal file
View File

@@ -0,0 +1,23 @@
[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:674](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L674)

2
docs/api/namespaces/Parser/functions/parseFormats.md
View File

@@ -16,4 +16,4 @@
## Defined in
[src/parser/parser.ts:680](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L680)
[src/parser/parser.ts:740](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L740)

8
docs/api/namespaces/Parser/functions/parseItem.md
View File

@@ -6,7 +6,7 @@
> **parseItem**\<`T`, `K`\>(`data`, `validTypes`): `InstanceType`\<`K`\[`number`\]\> \| `null`
Parses a single item.
Parses an item.
### Type Parameters
@@ -30,7 +30,7 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:511](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L511)
[src/parser/parser.ts:510](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L510)
## parseItem(data, validTypes)
@@ -52,7 +52,7 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:512](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L512)
[src/parser/parser.ts:511](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L511)
## parseItem(data)
@@ -68,4 +68,4 @@ YTNode types that are allowed to be parsed.
### Defined in
[src/parser/parser.ts:513](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L513)
[src/parser/parser.ts:512](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L512)

2
docs/api/namespaces/Parser/functions/parseLC.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:636](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L636)
[src/parser/parser.ts:696](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L696)

2
docs/api/namespaces/Parser/functions/parseRR.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:657](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L657)
[src/parser/parser.ts:717](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L717)

4
docs/api/namespaces/Parser/functions/parseResponse.md
View File

@@ -4,7 +4,7 @@
> **parseResponse**\<`T`\>(`data`): `T`
Parses given InnerTube response.
Parses a given InnerTube response.
## Type Parameters
@@ -22,4 +22,4 @@ Raw data.
## Defined in
[src/parser/parser.ts:222](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L222)
[src/parser/parser.ts:229](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L229)

2
docs/api/namespaces/Parser/functions/sanitizeClassName.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:187](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L187)
[src/parser/parser.ts:194](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L194)

2
docs/api/namespaces/Parser/functions/setParserErrorHandler.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:154](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L154)
[src/parser/parser.ts:161](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L161)

2
docs/api/namespaces/Parser/functions/shouldIgnore.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:183](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L183)
[src/parser/parser.ts:190](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L190)

2
docs/api/namespaces/Parser/type-aliases/ParserError.md
View File

@@ -12,4 +12,4 @@
## Defined in
[src/parser/parser.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L37)
[src/parser/parser.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L44)

2
docs/api/namespaces/Parser/type-aliases/ParserErrorHandler.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/parser.ts:64](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/parser.ts#L64)
[src/parser/parser.ts:71](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/parser.ts#L71)