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

45
docs/api/namespaces/YT/classes/Guide.md Normal file
View File

@@ -0,0 +1,45 @@
[youtubei.js](../../../README.md) / [YT](../README.md) / Guide
# Class: Guide
## Constructors
### new Guide()
> **new Guide**(`data`): [`Guide`](Guide.md)
#### Parameters
• **data**: [`IRawResponse`](../../APIResponseTypes/interfaces/IRawResponse.md)
#### Returns
[`Guide`](Guide.md)
#### Defined in
[src/parser/youtube/Guide.ts:13](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Guide.ts#L13)
## Properties
### contents?
> `optional` **contents**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GuideSection`](../../YTNodes/classes/GuideSection.md) \| [`GuideSubscriptionsSection`](../../YTNodes/classes/GuideSubscriptionsSection.md)\>
#### Defined in
[src/parser/youtube/Guide.ts:11](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Guide.ts#L11)
## Accessors
### page
> `get` **page**(): [`IGuideResponse`](../../APIResponseTypes/type-aliases/IGuideResponse.md)
#### Returns
[`IGuideResponse`](../../APIResponseTypes/type-aliases/IGuideResponse.md)
#### Defined in
[src/parser/youtube/Guide.ts:19](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/Guide.ts#L19)