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

25
docs/api/namespaces/Helpers/interfaces/Constructor.md Normal file
View File

@@ -0,0 +1,25 @@
[youtubei.js](../../../README.md) / [Helpers](../README.md) / Constructor
# Interface: Constructor\<T\>
## Type Parameters
• **T**
## Constructors
### new Constructor()
> **new Constructor**(...`args`): `T`
#### Parameters
• ...**args**: `any`[]
#### Returns
`T`
#### Defined in
[src/parser/helpers.ts:312](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L312)

35
docs/api/namespaces/Helpers/interfaces/YTNodeConstructor.md Normal file
View File

@@ -0,0 +1,35 @@
[youtubei.js](../../../README.md) / [Helpers](../README.md) / YTNodeConstructor
# Interface: YTNodeConstructor\<T\>
## Type Parameters
• **T** *extends* [`YTNode`](../classes/YTNode.md) = [`YTNode`](../classes/YTNode.md)
## Constructors
### new YTNodeConstructor()
> **new YTNodeConstructor**(`data`): `T`
#### Parameters
• **data**: `any`
#### Returns
`T`
#### Defined in
[src/parser/helpers.ts:316](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L316)
## Properties
### type
> `readonly` **type**: `string`
#### Defined in
[src/parser/helpers.ts:317](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/helpers.ts#L317)