Spotify Wrapper
A wrapper to work with the Spotify Web API.
Browser Support
This library relies on Fetch API. And this API is supported in the following browsers.
| | | | |
---|
39+ ✔ | 42+ ✔ | 29+ ✔ | 10.1+ ✔ | Nope ✘ |
Dependencies
This library depends on fetch to make requests to the Spotify Web API. For environments that don't support fetch, you'll need to provide a polyfill to browser or polyfill to Node.
Installation
$ npm install spotify-wrapper --save
How to use
ES6
import SpotifyWrapper from 'spotify-wrapper';
const spotify = new SpotifyWrapper({
token: 'YOUR_TOKEN_HERE'
});
spotify.search.artists('Incubus');
CommonJS
const SpotifyWrapper = require('spotify-wrapper').default;
const spotify = new SpotifyWrapper({
token: 'YOUR_TOKEN_HERE'
});
UMD in Browser
<script src="spotify-wrapper.umd.js"></script>
<script src="spotify-wrapper.umd.min.js"></script>
After that the library will be available to the Global as SpotifyWrapper
. Follow an example:
const spotify = new SpotifyWrapper({
token: 'YOUR_TOKEN_HERE'
});
const albums = spotify.search.albums('Choosen Artist');
Methods
Follow the methods that the library provides.
search.albums(query)
Search for informations about Albums with provided query. Test in Spotify Web Console with type defined as album.
Arguments
Argument | Type | Options |
---|
query | string | 'Any search query' |
Example
spotify.search.albums('Incubus')
.then(data => {
})
search.artists(query)
Search for informations about Artists with provided query. Test in Spotify Web Console with type defined as artist.
Arguments
Argument | Type | Options |
---|
query | string | 'Any search query' |
Example
spotify.search.artists('Incubus')
.then(data => {
})
search.tracks(query)
Search for informations about Tracks with provided query. Test in Spotify Web Console with type defined as track.
Arguments
Argument | Type | Options |
---|
query | string | 'Any search query' |
Example
spotify.search.tracks('Drive')
.then(data => {
})
search.playlists(query)
Search for informations about Playlist with provided query. Test in Spotify Web Console with type defined as playlist.
Arguments
Argument | Type | Options |
---|
query | string | 'Any search query' |
Example
spotify.search.playlists('Happy Day')
.then(data => {
})
album.getAlbum(id)
Search for informations about a specific Album with provided id. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|
id | string | 'Specific id' |
Example
spotify.album.getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
.then(data => {
})
album.getAlbums(ids)
Search for informations about some Albums with all id's. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|
ids | Array of strings | ['id1', 'id2'] |
Example
spotify.album.getAlbums(['4aawyAB9vmqN3uQ7FjRGTy', '1A2GTWGtFfWp7KSQTwWOyo'])
.then(data => {
})
album.getTracks(id)
Search for all tracks in a specific Album with provided id. Test in Spotify Web Console.
Arguments
Argument | Type | Options |
---|
id | string | 'Specific id' |
Example
spotify.album.getTracks('4aawyAB9vmqN3uQ7FjRGTy')
.then(data => {
})