spotify-wrapper-test-tdd

Spotify Wrapper

project for Javascript and TDD studies (with jasmine)

Course:https://www.udemy.com/course/js-com-tdd-na-pratica by Willian Justen

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-test-tdd --save

How to use

ES6

// to import a specific method
import { method } from 'spotify-wrapper-test-tdd';

// to import everything
import * as spotifyWrapper from 'spotify-wrapper-test-tdd';

CommonJS

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

UMD in Browser

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

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

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

const albums = spotifyWrapper.albums.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
type	Array of strings	['artist', 'album', 'track', 'playlist']
query	string	'Any search query'

Example

searchItems(['artist', 'album'], 'Incubus').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

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

albums.searchAlbumsById('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

searchAlbumsById(['4aawyAB9vmqN3uQ7FjRGTy', '1A2GTWGtFfWp7KSQTwWOyo']).then((data) => {
  // do what you want with the data
});

License

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