YouTube.js/docs/api/namespaces/YTMusic/classes/Playlist.md

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:32

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:151

---

items

get items(): ObservedArray<MusicResponsiveListItem>

Returns

ObservedArray<MusicResponsiveListItem>

Defined in

src/parser/ytmusic/Playlist.ts:147

---

page

get page(): IBrowseResponse

Returns

IBrowseResponse

Defined in

src/parser/ytmusic/Playlist.ts:143

Methods

getContinuation()

getContinuation(): Promise<Playlist>

Retrieves playlist items continuation.

Returns

Promise<Playlist>

Defined in

src/parser/ytmusic/Playlist.ts:58

---

getRelated()

getRelated(): Promise<MusicCarouselShelf>

Retrieves related playlists

Returns

Promise<MusicCarouselShelf>

Defined in

src/parser/ytmusic/Playlist.ts:73

---

getSuggestions()

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

Parameters

• refresh: boolean = true

Returns

Promise<ObservedArray<MusicResponsiveListItem>>

Defined in

src/parser/ytmusic/Playlist.ts:102