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,35 @@
[youtubei.js](../../../README.md) / [Generator](../README.md) / parse
# Function: parse()
> **parse**(`key`, `inference_type`, `data`, `key_path`): `any`
Parse a value from a given key path using the given inference type
## Parameters
**key**: `string`
The key to parse
**inference\_type**: [`InferenceType`](../type-aliases/InferenceType.md)
The inference type to parse
**data**: `unknown`
The data to parse from
**key\_path**: `string`[] = `...`
The path to the key (excluding the key itself)
## Returns
`any`
The parsed value
## Defined in
[src/parser/generator.ts:678](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L678)