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

29
docs/api/namespaces/Generator/functions/generateRuntimeClass.md Normal file
View File

@@ -0,0 +1,29 @@
[youtubei.js](../../../README.md) / [Generator](../README.md) / generateRuntimeClass
# Function: generateRuntimeClass()
> **generateRuntimeClass**(`classname`, `classdata`, `logger`): [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
Given example data for a class, introspect, implement dependencies, and create a new class
## Parameters
• **classname**: `string`
The name of the class
• **classdata**: `unknown`
The example of the class
• **logger**: [`ParserErrorHandler`](../../Parser/type-aliases/ParserErrorHandler.md)
## Returns
[`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
Class based on the example classdata extending YTNode
## Defined in
[src/parser/generator.ts:470](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L470)