Spotify Wrapper

An simple and humanized JavaScript interface wrapper to Spotify API.

Browser Support

This wrapper was implemented using Fetch API and this resource is supported in the following browsers:

| | | | | --- | --- | --- | --- | --- | 39+ ✔ | 42+ ✔ | 29+ ✔ | 10.1+ ✔ | Nope ✘ |

Dependencies

The only dependency of this API is a fetch to make requests to Spotify web API. For environments that don't offer support to fetch, you will need to provide an polifyl to browsers or polifyl to node

Installing

To install is very simple, see the follow example:

$ npm install spotify-wrapper --save

Usage

ES6

// To import an specific method: 
   import { method } from 'spotify-wrapper';

// To import all: 
   import * as spotifyWrapper from 'spotify-wrapper';

CommonJS

var spotifyWrapper = require('spotify-wrapper');

UMD in Browsers

<!-- Not minified -->
<script src="spotify-wrapper.umd.js"></script>

<!-- Or minified -->
<script src="spotify-wrapper.umd.min.js"></script>

After that the library is be avaliable to the Global as spotifyWrapper. Follow an example:

const albums = spotifyWrapper.searchAlbums('Strokes');

Methods

Follow the methods that the library provides.

generalSearch(query, types)

Search information about artists, albums, tracks and playlists, you can also check in Spotify API Console.

| Argument | Type | Options | |----------|-------------------|-----------------------------------------| |query |String | 'Any search query' | |type |Array of Strings | ['artist', 'album', 'track', 'playlist']|

generalSearch('Strokes', ['artists', 'album'])
   .then( data => {
       // Do what you want with response.
   });

playlistSearch(query)

Search playlists an our informations, you can also check in Spotify API Console with type defined as playlist.

| Argument | Type | Options | |----------|----------|--------------------| | query | String | 'Any search query' |

playlistSearch('Strokes')
   .then( data => {
       // Do what you want with response.
   });

artistSearch(query)

Search for artists avaliable on spotify, you can also check in Spotify API Console with type defined as artist.

| Argument | Type | Options | |----------|----------|--------------------| | query | String | 'Any search query' |

artistSearch('Strokes')
   .then( data => {
       // Do what you want with response.
   });

albumSearch(query)

Search for albums avaliable on spotify, you can also check in Spotify API Console with type defined as album.

| Argument | Type | Options | |----------|----------|--------------------| | query | String | 'Any search query' |

albumSearch('Strokes')
   .then( data => {
       // Do what you want with response.
   });

trackSearch(query)

Search for tracks avaliable on spotify, you can also check in Spotify API Console with type defined as track.

| Argument | Type | Options | |----------|----------|--------------------| | query | String | 'Any search query' |

trackSearch('Strokes')
   .then( data => {
       // Do what you want with response.
   });

getAlbum(albumID)

Get an specific album by ID you can check and test in Spotify API Console.

| Argument | Type | Options | |----------|----------|-----------------------------------| | ID | String | 'Specific SpotifyAlbumID' |

getAlbum('0sNOF9WDwhWunNAHPD3Baj')
   .then( data => {
       // Do what you want with response.
   });

getAlbumTracks(albumID)

Get all avaliable tracks of an specific album by album ID you can check and test in Spotify API Console.

| Argument | Type | Options | |----------|----------|-----------------------------------| | ID | String | 'Specific SpotifyAlbumID' |

getAlbumTracks('0sNOF9WDwhWunNAHPD3Baj')
   .then( data => {
       // Do what you want with response.
   });

getAlbums([albumID])

Get various albums by array of album ID you can check and test in Spotify API Console.

| Argument | Type | Options | |----------|--------------------|-----------------------------------| | IDs | Array of Strings | 'Specific SpotifyAlbumID' |

getAlbums(['0sNOF9WDwhWunNAHPD3Baj','1sNA78WDwhTunDAHS6SDAj'])
   .then( data => {
       // Do what you want with response.
   });

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Ayrton Felipe - Initial work - PurpleBooth

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

To My current instructor for this course Willian Justen to provide a good explanation and examples of this methodology of development.