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,24 @@
[youtubei.js](../../../README.md) / [Helpers](../README.md) / observe
# Function: observe()
> **observe**\<`T`\>(`obj`): [`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\>
Creates a trap to intercept property access
and add utilities to an object.
## Type Parameters
**T** *extends* [`YTNode`](../classes/YTNode.md)
## Parameters
**obj**: `T`[]
## Returns
[`ObservedArray`](../type-aliases/ObservedArray.md)\<`T`\>
## Defined in
[src/parser/helpers.ts:394](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L394)