tiagonunes-spotify-wrapper
v1.0.2
Published
A wrapper to work with the Spotify Web API.
Downloads
4
Readme
(Tiago Nunes) 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 i tiagonunes-spotify-wrapper
How to use
ES6
// to import a specific method
import { method } from 'tiagonunes-spotify-wrapper';
// to import everything
import * as spotifyWrapper from 'tiagonunes-spotify-wrapper';
CommonJS
var spotifyWrapper = require('tiagonunes-spotify-wrapper');
UMD in Browser
<!-- to import non-minified version -->
<script src="tiagonunes-spotify-wrapper.umd.js"></script>
<!-- to import minified version -->
<script src="tiagonunes-spotify-wrapper.umd.min.js"></script>
After that the library will be available to the Global as spotifyWrapper
. Follow an example:
const albums = tiagonunesSpotifyWrapper.searchAlbums('Choosen Artist');
Methods
Follow the methods that the library provides.
search(query, types)
Search for informations about artists, albums, tracks or playlists. Test in Spotify Web Console.
Arguments
| Argument | Type | Options |
|----------|-------------------|-----------------------------------------|
|query
|string | 'Any search query' |
|type
|Array of strings | ['artist', 'album', 'track', 'playlist']|
Example
search('Fernandinho', ['artist', 'album'])
.then(data => {
// do what you want with the data
})
searchAlbums(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
searchAlbums('Fernandinho')
.then(data => {
// do what you want with the data
})
searchArtists(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
searchArtists('Fernandinho')
.then(data => {
// do what you want with the data
})
searchTracks(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
searchTracks('Uma nova história')
.then(data => {
// do what you want with the data
})
searchPlaylists(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
searchPlaylists('Galileu')
.then(data => {
// do what you want with the data
})
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
getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
.then(data => {
// do what you want with the data
})
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
getAlbum(['4aawyAB9vmqN3uQ7FjRGTy', '1A2GTWGtFfWp7KSQTwWOyo'])
.then(data => {
// do what you want with the data
})
getAlbumTracks(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
getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
.then(data => {
// do what you want with the data
})
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
| |
|:---------------------:|
| Tiago Nunes |
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details