Files
YouTube.js/docs/api/namespaces/YTMusic/classes/Playlist.md
Luan 74659fd03f chore: add proper documentation (#763)
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
2024-09-23 17:32:50 -03:00

4.2 KiB

youtubei.js / YTMusic / Playlist

Class: Playlist

Constructors

new Playlist()

new Playlist(response, actions): Playlist

Parameters

response: ApiResponse

actions: Actions

Returns

Playlist

Defined in

src/parser/ytmusic/Playlist.ts:29

Properties

background?

optional background: MusicThumbnail

Defined in

src/parser/ytmusic/Playlist.ts:27


contents?

optional contents: ObservedArray<MusicResponsiveListItem>

Defined in

src/parser/ytmusic/Playlist.ts:26


header?

optional header: MusicDetailHeader | MusicResponsiveHeader | MusicEditablePlaylistDetailHeader

Defined in

src/parser/ytmusic/Playlist.ts:25

Accessors

has_continuation

get has_continuation(): boolean

Returns

boolean

Defined in

src/parser/ytmusic/Playlist.ts:148


items

get items(): ObservedArray<MusicResponsiveListItem>

Returns

ObservedArray<MusicResponsiveListItem>

Defined in

src/parser/ytmusic/Playlist.ts:144


page

get page(): IBrowseResponse

Returns

IBrowseResponse

Defined in

src/parser/ytmusic/Playlist.ts:140

Methods

getContinuation()

getContinuation(): Promise<Playlist>

Retrieves playlist items continuation.

Returns

Promise<Playlist>

Defined in

src/parser/ytmusic/Playlist.ts:55


getRelated()

getRelated(): Promise<MusicCarouselShelf>

Retrieves related playlists

Returns

Promise<MusicCarouselShelf>

Defined in

src/parser/ytmusic/Playlist.ts:70


getSuggestions()

getSuggestions(refresh): Promise<ObservedArray<MusicResponsiveListItem>>

Parameters

refresh: boolean = true

Returns

Promise<ObservedArray<MusicResponsiveListItem>>

Defined in

src/parser/ytmusic/Playlist.ts:99