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

73
docs/api/namespaces/YTMusic/classes/Recap.md Normal file
View File

@@ -0,0 +1,73 @@
[youtubei.js](../../../README.md) / [YTMusic](../README.md) / Recap
# Class: Recap
## Constructors
### new Recap()
> **new Recap**(`response`, `actions`): [`Recap`](Recap.md)
#### Parameters
• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md)
• **actions**: [`Actions`](../../../classes/Actions.md)
#### Returns
[`Recap`](Recap.md)
#### Defined in
[src/parser/ytmusic/Recap.ts:26](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/Recap.ts#L26)
## Properties
### header?
> `optional` **header**: [`MusicHeader`](../../YTNodes/classes/MusicHeader.md) \| [`HighlightsCarousel`](../../YTNodes/classes/HighlightsCarousel.md)
#### Defined in
[src/parser/ytmusic/Recap.ts:23](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/Recap.ts#L23)
***
### sections?
> `optional` **sections**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ItemSection`](../../YTNodes/classes/ItemSection.md) \| [`Message`](../../YTNodes/classes/Message.md) \| [`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md)\>
#### Defined in
[src/parser/ytmusic/Recap.ts:24](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/Recap.ts#L24)
## Accessors
### page
> `get` **page**(): [`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)
#### Returns
[`IBrowseResponse`](../../APIResponseTypes/type-aliases/IBrowseResponse.md)
#### Defined in
[src/parser/ytmusic/Recap.ts:60](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/Recap.ts#L60)
## Methods
### getPlaylist()
> **getPlaylist**(): `Promise`\<[`Playlist`](Playlist.md)\>
Retrieves recap playlist.
#### Returns
`Promise`\<[`Playlist`](Playlist.md)\>
#### Defined in
[src/parser/ytmusic/Recap.ts:47](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/Recap.ts#L47)