Class default

Hierarchy

default
- default

Constructors

constructor

new default(auth): default
Parameters
- auth: IAuth
Returns default
Overrides SpotifyApi.constructor
- Defined in Spotify.ts:12

Properties

nextTokenRefreshTime

nextTokenRefreshTime: Date

Methods

checkCredentials

checkCredentials(): Promise<void>
Returns Promise<void>
Inherited from SpotifyApi.checkCredentials
- Defined in lib/API.ts:26

downloadAlbum

downloadAlbum(url): Promise<(string | Buffer)[]>
Downloads the tracks of a Album
Parameters
- url: string
  
  URL of the Album
Returns Promise<(string | Buffer)[]>
Promise<(string|Buffer)[]>
- Defined in Spotify.ts:149

downloadPlaylist

downloadPlaylist(url): Promise<(string | Buffer)[]>
Downloads the tracks of a playlist
Parameters
- url: string
  
  URL of the playlist
Returns Promise<(string | Buffer)[]>
Promise<(string|Buffer)[]>
- Defined in Spotify.ts:142

downloadTrack

downloadTrack<T>(url, filename?): Promise<T extends undefined
? Buffer
: string>
Downloads the given spotify track
Type Parameters
- T extends undefined | string
Parameters
- url: string
  
  Url to download
- Optional filename: T
  
  file to save to
Returns Promise<T extends undefined
? Buffer
: string>
buffer if no filename is provided and string if it is
- Defined in Spotify.ts:92

downloadTrackFromInfo

downloadTrackFromInfo(info): Promise<Buffer>
Gets the Buffer of track from the info
Parameters
- info: default
  
  info of the track got from spotify.getTrack()
Returns Promise<Buffer>
- Defined in Spotify.ts:117

extractAlbum

extractAlbum(albumId): Promise<default>
Parameters
- albumId: string
Returns Promise<default>
Inherited from SpotifyApi.extractAlbum
- Defined in lib/API.ts:78

extractArtist

extractArtist(artistId): Promise<default>
Parameters
- artistId: string
Returns Promise<default>
Inherited from SpotifyApi.extractArtist
- Defined in lib/API.ts:100

extractArtistAlbums

extractArtistAlbums(artistId): Promise<AlbumObjectSimplified[]>
Parameters
- artistId: string
Returns Promise<AlbumObjectSimplified[]>
Inherited from SpotifyApi.extractArtistAlbums
- Defined in lib/API.ts:105

extractPlaylist

extractPlaylist(playlistId): Promise<default>
Parameters
- playlistId: string
Returns Promise<default>
Inherited from SpotifyApi.extractPlaylist
- Defined in lib/API.ts:55

extractTrack

extractTrack(trackId): Promise<default>
Parameters
- trackId: string
Returns Promise<default>
Inherited from SpotifyApi.extractTrack
- Defined in lib/API.ts:42

getAlbum

getAlbum(url): Promise<default>
Gets the info the given album URL
Parameters
- url: string
Returns Promise<default>
Album
- Defined in Spotify.ts:31

getArtist

getArtist(url): Promise<default>
Gets the info of the given Artist URL
Parameters
- url: string
Returns Promise<default>
Artist
- Defined in Spotify.ts:41

getArtistAlbums

getArtistAlbums(url): Promise<{
albums: default[];
artist: default;
}>
Gets the list of albums from the given Artists URL
Parameters
- url: string
Returns Promise<{
albums: default[];
artist: default;
}>
Albums
- Defined in Spotify.ts:51

getID

getID(url): string
Parameters
- url: string
Returns string
- Defined in Spotify.ts:81

getPlaylist

getPlaylist(url): Promise<default>
Gets the playlist info from URL
Parameters
- url: string
  
  URL of the playlist
Returns Promise<default>
- Defined in Spotify.ts:76

getSpotifyUser

getSpotifyUser(id): Promise<UserObjectPublic>
Parameters
- id: string
Returns Promise<UserObjectPublic>
- Defined in Spotify.ts:185

getTrack

getTrack(url): Promise<default>
Get the track details of the given track URL
Parameters
- url: string
Returns Promise<default>
Track
- Defined in Spotify.ts:21

getTracksFromAlbum

getTracksFromAlbum(url): Promise<{
    name: string;
    total_tracks: number;
    tracks: default[];
}>
Gets the info of tracks from Album URL
Parameters
- url: string
  
  URL of the playlist
Returns Promise<{
    name: string;
    total_tracks: number;
    tracks: default[];
}>
- Defined in Spotify.ts:172

getTracksFromPlaylist

getTracksFromPlaylist(url): Promise<{
    name: string;
    total_tracks: number;
    tracks: default[];
}>
Gets the info of tracks from playlist URL
Parameters
- url: string
  
  URL of the playlist
Returns Promise<{
    name: string;
    total_tracks: number;
    tracks: default[];
}>
- Defined in Spotify.ts:155

getUser

getUser(id): Promise<UserObjectPublic>
Parameters
- id: string
Returns Promise<UserObjectPublic>
Inherited from SpotifyApi.getUser
- Defined in lib/API.ts:122

refreshToken

refreshToken(): Promise<void>
Returns Promise<void>
Inherited from SpotifyApi.refreshToken
- Defined in lib/API.ts:37

requestTokens

requestTokens(): Promise<void>
Returns Promise<void>
Inherited from SpotifyApi.requestTokens
- Defined in lib/API.ts:31

verifyCredentials

verifyCredentials(): Promise<void>
Returns Promise<void>
Inherited from SpotifyApi.verifyCredentials
- Defined in lib/API.ts:18

Generated using TypeDoc