youtubei.js / YTMusic / Playlist

Class: Playlist

Defined in: src/parser/ytmusic/Playlist.ts:22

Constructors

Constructor

new Playlist(response, actions): Playlist

Defined in: src/parser/ytmusic/Playlist.ts:34

Parameters

response

ApiResponse

actions

Actions

Returns

Playlist

Properties

background?

optional background: MusicThumbnail

Defined in: src/parser/ytmusic/Playlist.ts:29

contents?

optional contents: ObservedArray<ContinuationItem | MusicResponsiveListItem>

Defined in: src/parser/ytmusic/Playlist.ts:28

header?

optional header: MusicDetailHeader | MusicResponsiveHeader | MusicEditablePlaylistDetailHeader

Defined in: src/parser/ytmusic/Playlist.ts:27

Accessors

has_continuation

Get Signature

get has_continuation(): boolean

Defined in: src/parser/ytmusic/Playlist.ts:163

Returns

boolean

items

Get Signature

get items(): ObservedArray<ContinuationItem | MusicResponsiveListItem>

Defined in: src/parser/ytmusic/Playlist.ts:159

Returns

ObservedArray<ContinuationItem | MusicResponsiveListItem>

page

Get Signature

get page(): IBrowseResponse

Defined in: src/parser/ytmusic/Playlist.ts:155

Returns

IBrowseResponse

Methods

getContinuation()

getContinuation(): Promise<Playlist>

Defined in: src/parser/ytmusic/Playlist.ts:64

Retrieves playlist items continuation.

Returns

Promise<Playlist>

getRelated()

getRelated(): Promise<MusicCarouselShelf>

Defined in: src/parser/ytmusic/Playlist.ts:85

Retrieves related playlists

Returns

Promise<MusicCarouselShelf>

getSuggestions()

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

Defined in: src/parser/ytmusic/Playlist.ts:114

Parameters

refresh

boolean = true

Returns

Promise<ObservedArray<MusicResponsiveListItem>>