Class SpotifyPlaylist

constructor

• new SpotifyPlaylist(
      data: any,
      spotifyData: SpotifyDataOptions,
      search: boolean,
  ): SpotifyPlaylist

  Constructor for Spotify Playlist Class

  Parameters

  • data: any

    JSON parsed data of playlist

  • spotifyData: SpotifyDataOptions

    Data about sporify token for furhter fetching.

  • search: boolean

  Returns SpotifyPlaylist

collaborative

description

id

name

owner

thumbnail

tracksCount

type

url

total_pages

• get total_pages(): number

  Gets total number of pages in that playlist class.

  Returns number

  See

  SpotifyPlaylist.all_tracks

total_tracks

• get total_tracks(): number

  Spotify Playlist total no of tracks that have been fetched so far.

  Returns number

all_tracks

• all_tracks(): Promise<SpotifyTrack[]>

  Fetches all the tracks in the playlist and returns them

  const playlist = await play.spotify('playlist url')
  
  const tracks = await playlist.all_tracks()
  Copy

  Returns Promise<SpotifyTrack[]>

  An array of SpotifyTrack

fetch

• fetch(): Promise<SpotifyPlaylist>

  Fetches Spotify Playlist tracks more than 100 tracks.

  For getting all tracks in playlist, see total_pages property.

  Returns Promise<SpotifyPlaylist>

  Playlist Class.

page

• page(num: number): SpotifyTrack[]

  Spotify Playlist tracks are divided in pages.

  For example getting data of 101 - 200 videos in a playlist,

  const playlist = await play.spotify('playlist url')
  
  await playlist.fetch()
  
  const result = playlist.page(2)
  Copy

  Parameters

  • num: number

    Page Number

  Returns SpotifyTrack[]

toJSON

• toJSON(): PlaylistJSON

  Converts Class to JSON

  Returns PlaylistJSON

  JSON data