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

chore: add proper documentation (#763)

Browse Source 
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
This commit is contained in:
Luan
2024-09-23 17:32:50 -03:00
committed by GitHub
parent dd7f5cf778
commit 74659fd03f
853 changed files with 139814 additions and 1929 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/api/namespaces/Generator/interfaces/ObjectInferenceType.md Normal file
View File

@@ -0,0 +1,33 @@
[youtubei.js](../../../README.md) / [Generator](../README.md) / ObjectInferenceType
# Interface: ObjectInferenceType
## Properties
### keys
> **keys**: [`KeyInfo`](../type-aliases/KeyInfo.md)
#### Defined in
[src/parser/generator.ts:37](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L37)
***
### optional
> **optional**: `boolean`
#### Defined in
[src/parser/generator.ts:38](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L38)
***
### type
> **type**: `"object"`
#### Defined in
[src/parser/generator.ts:36](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L36)

33
docs/api/namespaces/Generator/interfaces/PrimativeInferenceType.md Normal file
View File

@@ -0,0 +1,33 @@
[youtubei.js](../../../README.md) / [Generator](../README.md) / PrimativeInferenceType
# Interface: PrimativeInferenceType
## Properties
### optional
> **optional**: `boolean`
#### Defined in
[src/parser/generator.ts:50](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L50)
***
### type
> **type**: `"primative"`
#### Defined in
[src/parser/generator.ts:48](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L48)
***
### typeof
> **typeof**: (`"string"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"symbol"` \| `"undefined"` \| `"function"` \| `"unknown"` \| `"never"`)[]
#### Defined in
[src/parser/generator.ts:49](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L49)

33
docs/api/namespaces/Generator/interfaces/RendererInferenceType.md Normal file
View File

@@ -0,0 +1,33 @@
[youtubei.js](../../../README.md) / [Generator](../README.md) / RendererInferenceType
# Interface: RendererInferenceType
## Properties
### optional
> **optional**: `boolean`
#### Defined in
[src/parser/generator.ts:44](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L44)
***
### renderers
> **renderers**: `string`[]
#### Defined in
[src/parser/generator.ts:43](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L43)
***
### type
> **type**: `"renderer"`
#### Defined in
[src/parser/generator.ts:42](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L42)