jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-16 19:12:24 +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/Generator/README.md
View File

@@ -7,7 +7,7 @@
### Interfaces
- [ObjectInferenceType](interfaces/ObjectInferenceType.md)
- [PrimativeInferenceType](interfaces/PrimativeInferenceType.md)
- [PrimitiveInferenceType](interfaces/PrimitiveInferenceType.md)
- [RendererInferenceType](interfaces/RendererInferenceType.md)
### Type Aliases

2
docs/api/namespaces/Generator/functions/camelToSnake.md
View File

@@ -14,4 +14,4 @@
## Defined in
[src/parser/generator.ts:80](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L80)
[src/parser/generator.ts:82](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L82)

4
docs/api/namespaces/Generator/functions/createRuntimeClass.md
View File

@@ -18,6 +18,8 @@ The resolved key info
• **logger**: [`ParserErrorHandler`](../../Parser/type-aliases/ParserErrorHandler.md)
The logger to log errors to
## Returns
[`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)
@@ -26,4 +28,4 @@ Class based on the key info extending YTNode
## Defined in
[src/parser/generator.ts:408](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L408)
[src/parser/generator.ts:411](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L411)

4
docs/api/namespaces/Generator/functions/generateRuntimeClass.md
View File

@@ -18,6 +18,8 @@ The example of the class
• **logger**: [`ParserErrorHandler`](../../Parser/type-aliases/ParserErrorHandler.md)
The logger to log errors to
## Returns
[`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
@@ -26,4 +28,4 @@ Class based on the example classdata extending YTNode
## Defined in
[src/parser/generator.ts:470](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L470)
[src/parser/generator.ts:474](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L474)

2
docs/api/namespaces/Generator/functions/generateTypescriptClass.md
View File

@@ -24,4 +24,4 @@ Typescript class file
## Defined in
[src/parser/generator.ts:491](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L491)
[src/parser/generator.ts:495](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L495)

4
docs/api/namespaces/Generator/functions/inferType.md
View File

@@ -4,7 +4,7 @@
> **inferType**(`key`, `value`): [`InferenceType`](../type-aliases/InferenceType.md)
Infer the type of a key given its value
Infer the type of key given its value
## Parameters
@@ -24,4 +24,4 @@ The inferred type
## Defined in
[src/parser/generator.ts:90](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L90)
[src/parser/generator.ts:92](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L92)

2
docs/api/namespaces/Generator/functions/introspect.md
View File

@@ -28,4 +28,4 @@ The key info and any unimplemented dependencies
## Defined in
[src/parser/generator.ts:374](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L374)
[src/parser/generator.ts:376](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L376)

2
docs/api/namespaces/Generator/functions/isArrayType.md
View File

@@ -20,4 +20,4 @@ If it is an array, return the InferenceType. Otherwise, return false.
## Defined in
[src/parser/generator.ts:220](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L220)
[src/parser/generator.ts:222](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L222)

2
docs/api/namespaces/Generator/functions/isIgnoredKey.md
View File

@@ -20,4 +20,4 @@ Whether or not the key is ignored
## Defined in
[src/parser/generator.ts:398](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L398)
[src/parser/generator.ts:400](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L400)

2
docs/api/namespaces/Generator/functions/isMiscType.md
View File

@@ -24,4 +24,4 @@ If it is a misc type, return the InferenceType. Otherwise, return false.
## Defined in
[src/parser/generator.ts:161](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L161)
[src/parser/generator.ts:163](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L163)

2
docs/api/namespaces/Generator/functions/isRenderer.md
View File

@@ -20,4 +20,4 @@ If it is a renderer, return the class name. Otherwise, return false.
## Defined in
[src/parser/generator.ts:200](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L200)
[src/parser/generator.ts:202](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L202)

2
docs/api/namespaces/Generator/functions/isRendererList.md
View File

@@ -21,4 +21,4 @@ Otherwise, return false.
## Defined in
[src/parser/generator.ts:139](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L139)
[src/parser/generator.ts:141](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L141)

2
docs/api/namespaces/Generator/functions/mergeKeyInfo.md
View File

@@ -32,4 +32,4 @@ The merged key info
## Defined in
[src/parser/generator.ts:736](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L736)
[src/parser/generator.ts:734](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L734)

2
docs/api/namespaces/Generator/functions/parse.md
View File

@@ -32,4 +32,4 @@ The parsed value
## Defined in
[src/parser/generator.ts:678](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L678)
[src/parser/generator.ts:681](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L681)

2
docs/api/namespaces/Generator/functions/toParser.md
View File

@@ -32,4 +32,4 @@ Statement to parse the given key
## Defined in
[src/parser/generator.ts:575](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L575)
[src/parser/generator.ts:578](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L578)

2
docs/api/namespaces/Generator/functions/toTypeDeclaration.md
View File

@@ -24,4 +24,4 @@ Typescript type declaration
## Defined in
[src/parser/generator.ts:516](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L516)
[src/parser/generator.ts:520](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L520)

6
docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md
View File

@@ -10,7 +10,7 @@
#### Defined in
[src/parser/generator.ts:37](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L37)
[src/parser/generator.ts:39](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L39)
***
@@ -20,7 +20,7 @@
#### Defined in
[src/parser/generator.ts:38](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L38)
[src/parser/generator.ts:40](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L40)
***
@@ -30,4 +30,4 @@
#### Defined in
[src/parser/generator.ts:36](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L36)
[src/parser/generator.ts:38](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L38)

12
docs/api/namespaces/Generator/interfaces/PrimativeInferenceType.md → docs/api/namespaces/Generator/interfaces/PrimitiveInferenceType.md
View File

@@ -1,6 +1,6 @@
[youtubei.js](../../../README.md) / [Generator](../README.md) / PrimativeInferenceType
[youtubei.js](../../../README.md) / [Generator](../README.md) / PrimitiveInferenceType
# Interface: PrimativeInferenceType
# Interface: PrimitiveInferenceType
## Properties
@@ -10,17 +10,17 @@
#### Defined in
[src/parser/generator.ts:50](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L50)
[src/parser/generator.ts:52](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L52)
***
### type
> **type**: `"primative"`
> **type**: `"primitive"`
#### Defined in
[src/parser/generator.ts:48](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L48)
[src/parser/generator.ts:50](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L50)
***
@@ -30,4 +30,4 @@
#### Defined in
[src/parser/generator.ts:49](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L49)
[src/parser/generator.ts:51](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L51)

6
docs/api/namespaces/Generator/interfaces/RendererInferenceType.md
View File

@@ -10,7 +10,7 @@
#### Defined in
[src/parser/generator.ts:44](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L44)
[src/parser/generator.ts:46](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L46)
***
@@ -20,7 +20,7 @@
#### Defined in
[src/parser/generator.ts:43](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L43)
[src/parser/generator.ts:45](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L45)
***
@@ -30,4 +30,4 @@
#### Defined in
[src/parser/generator.ts:42](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L42)
[src/parser/generator.ts:44](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L44)

2
docs/api/namespaces/Generator/type-aliases/ArrayInferenceType.md
View File

@@ -6,4 +6,4 @@
## Defined in
[src/parser/generator.ts:53](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L53)
[src/parser/generator.ts:55](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L55)

4
docs/api/namespaces/Generator/type-aliases/InferenceType.md
View File

@@ -2,8 +2,8 @@
# Type Alias: InferenceType
> **InferenceType**: [`RendererInferenceType`](../interfaces/RendererInferenceType.md) \| [`MiscInferenceType`](MiscInferenceType.md) \| [`ObjectInferenceType`](../interfaces/ObjectInferenceType.md) \| [`PrimativeInferenceType`](../interfaces/PrimativeInferenceType.md) \| [`ArrayInferenceType`](ArrayInferenceType.md)
> **InferenceType**: [`RendererInferenceType`](../interfaces/RendererInferenceType.md) \| [`MiscInferenceType`](MiscInferenceType.md) \| [`ObjectInferenceType`](../interfaces/ObjectInferenceType.md) \| [`PrimitiveInferenceType`](../interfaces/PrimitiveInferenceType.md) \| [`ArrayInferenceType`](ArrayInferenceType.md)
## Defined in
[src/parser/generator.ts:70](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L70)
[src/parser/generator.ts:72](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L72)

2
docs/api/namespaces/Generator/type-aliases/KeyInfo.md
View File

@@ -6,4 +6,4 @@
## Defined in
[src/parser/generator.ts:72](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L72)
[src/parser/generator.ts:74](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L74)

2
docs/api/namespaces/Generator/type-aliases/MiscInferenceType.md
View File

@@ -6,4 +6,4 @@
## Defined in
[src/parser/generator.ts:13](https://github.com/LuanRT/YouTube.js/blob/305a398158a6cac82e6ef288fed4bf1661c89d52/src/parser/generator.ts#L13)
[src/parser/generator.ts:15](https://github.com/LuanRT/YouTube.js/blob/fc5571629eca037af7de03f4b903da6add1f300b/src/parser/generator.ts#L15)