chore: add proper documentation (#763)

* 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

View File

@@ -0,0 +1,36 @@
[youtubei.js](../../README.md) / Generator
# Generator
## Index
### Interfaces
- [ObjectInferenceType](interfaces/ObjectInferenceType.md)
- [PrimativeInferenceType](interfaces/PrimativeInferenceType.md)
- [RendererInferenceType](interfaces/RendererInferenceType.md)
### Type Aliases
- [ArrayInferenceType](type-aliases/ArrayInferenceType.md)
- [InferenceType](type-aliases/InferenceType.md)
- [KeyInfo](type-aliases/KeyInfo.md)
- [MiscInferenceType](type-aliases/MiscInferenceType.md)
### Functions
- [camelToSnake](functions/camelToSnake.md)
- [createRuntimeClass](functions/createRuntimeClass.md)
- [generateRuntimeClass](functions/generateRuntimeClass.md)
- [generateTypescriptClass](functions/generateTypescriptClass.md)
- [inferType](functions/inferType.md)
- [introspect](functions/introspect.md)
- [isArrayType](functions/isArrayType.md)
- [isIgnoredKey](functions/isIgnoredKey.md)
- [isMiscType](functions/isMiscType.md)
- [isRenderer](functions/isRenderer.md)
- [isRendererList](functions/isRendererList.md)
- [mergeKeyInfo](functions/mergeKeyInfo.md)
- [parse](functions/parse.md)
- [toParser](functions/toParser.md)
- [toTypeDeclaration](functions/toTypeDeclaration.md)