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,23 @@
[youtubei.js](../../../README.md) / [Generator](../README.md) / isIgnoredKey
# Function: isIgnoredKey()
> **isIgnoredKey**(`key`): `boolean`
Is this key ignored by the parser?
## Parameters
**key**: `string` \| `symbol`
The key to check
## Returns
`boolean`
Whether or not the key is ignored
## Defined in
[src/parser/generator.ts:398](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/generator.ts#L398)