Class SpotifyAlbum

constructor

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

  Constructor for Spotify Album Class

  Parameters

  • data: any

    Json parsed album data

  • spotifyData: SpotifyDataOptions

    Spotify credentials

  • search: boolean

  Returns SpotifyAlbum

artists

copyrights

id

name

release_date

release_date_precision

thumbnail

tracksCount

type

url

total_pages

• get total_pages(): number

  Gets total number of pages in that album class.

  Returns number

  See

  SpotifyAlbum.all_tracks

total_tracks

• get total_tracks(): number

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

  Returns number

all_tracks

• all_tracks(): Promise<SpotifyTrack[]>

  Fetches all the tracks in the album and returns them

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

  Returns Promise<SpotifyTrack[]>

  An array of SpotifyTrack

fetch

• fetch(): Promise<SpotifyAlbum>

  Fetches Spotify Album tracks more than 50 tracks.

  For getting all tracks in album, see total_pages property.

  Returns Promise<SpotifyAlbum>

  Album Class.

page

• page(num: number): SpotifyTrack[] | undefined

  Spotify Album tracks are divided in pages.

  For example getting data of 51 - 100 videos in a album,

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

  Parameters

  • num: number

    Page Number

  Returns SpotifyTrack[] | undefined

toJSON

• toJSON(): AlbumJSON

  Converts Class to JSON

  Returns AlbumJSON

  JSON data