Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

spotify-wrapper-vini

Package Overview
Dependencies
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

spotify-wrapper-vini

A wrapper to work with the Spotify Web API.

  • 1.0.5
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
5
Maintainers
1
Weekly downloads
 
Created
Source

Spotify Wrapper

Build Status

Coverage Status

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.

ChromeFirefoxOperaSafariIE
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-vini --save

How to use

ES6

// to import a specific method
import SpotifyWrapper from 'spotify-wrapper-vini';

const spotify = new SpotifyWrapper({
  token: 'YOUR_TOKEN_HERE'
});

// using  method
spotify.search.artists('Incubus');

CommonJS

const SpotifyWrapper = require('spotify-wrapper-vini').default;

const spotify = new SpotifyWrapper({
  token: 'YOUR_TOKEN_HERE'
});

UMD in Browser

<!-- to import non-minified version -->
<script src="spotify-wrapper-vini.umd.js"></script>

<!-- to import minified version -->
<script src="spotify-wrapper-vini.umd.min.js"></script>

After that the library will be available to the Global as spotifyWrapper. Follow an example:

const albums = spotifyWrapper.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

ArgumentTypeOptions
querystring'Any search query'
typeArray of strings['artist', 'album', 'track', 'playlist']

Example

search('Incubus', ['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

ArgumentTypeOptions
querystring'Any search query'

Example

searchAlbums('Incubus').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

ArgumentTypeOptions
querystring'Any search query'

Example

searchArtists('Incubus').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

ArgumentTypeOptions
querystring'Any search query'

Example

searchTracks('Drive').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

ArgumentTypeOptions
querystring'Any search query'

Example

searchPlaylists('Happy Day').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

ArgumentTypeOptions
idstring'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

ArgumentTypeOptions
idsArray 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

ArgumentTypeOptions
idstring'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

| Vinicius Moret |

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

Keywords

FAQs

Package last updated on 02 Jan 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc