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) / mergeKeyInfo
# Function: mergeKeyInfo()
> **mergeKeyInfo**(`key_info`, `new_key_info`): `object`
Merges two sets of key info, resolving any conflicts
## Parameters
**key\_info**: [`KeyInfo`](../type-aliases/KeyInfo.md)
The current key info
**new\_key\_info**: [`KeyInfo`](../type-aliases/KeyInfo.md)
The new key info
## Returns
`object`
The merged key info
### changed\_keys
> **changed\_keys**: [`string`, [`InferenceType`](../type-aliases/InferenceType.md)][]
### resolved\_key\_info
> **resolved\_key\_info**: [`string`, [`InferenceType`](../type-aliases/InferenceType.md)][]
## Defined in
[src/parser/generator.ts:736](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L736)