js-spotify-wrapper

Spotify Wrapper

A uma aplicação que utiliza a Spotify Web API

Suporte aos Browsers

Essa biblioteca utiliza o Fetch API. E esta API é suportada nos seguintes browsers.

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

Dependências

Essa biblioteca depende do fetch para fazer requisições na API Spotify. Para ambientes que não suportam a tecnologia fetch, você precisa prover um polyfill para o navegador ou polyfill para o Node.

Instalação

$ npm install js-spotify-wrapper --save

Como utilizar

ES6

// para importar um método especifico
import { method } from 'js-spotify-wrapper';

// para importar tudo
import * as spotifyWrapper from 'js-spotify-wrapper';

CommonJS

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

UMD in Browser

<!-- para importar a versão não-minificada -->
<script src="spotify-wrapper.umd.js"></script>

<!-- para importar a versão minificada -->
<script src="spotify-wrapper.umd.min.js"></script>

Após isto, a API ficará disponível pelo nome de SpotifyWrapper, como mostra o exemplo:

const albums = spotifyWrapper.searchAlbums('Artista escolhido');

Metódos

Confira os métodos que a biblioteca disponibiliza

searchAll(query, tipo)

Procure por infromações de artistas, albums, faixas e playlists. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
query	string	'Pesquise qualquer coisa'
tipo	Array de Strings	['artist', 'album', 'track', 'playlist']

Exemplo

search('Veil of Maya', ['artist', 'album'])
  .then(data => {
    // faça o que quiser com o resultado
  })

searchAlbums(query)

Procure informações sobre Albums. Teste em: Spotify Web Console com o tipo definido como album.

Argumentos

Argumento	Tipo	Opções
query	string	'Pesquise qualquer coisa'

Exemplo

searchAlbums('Veil of Maya')
  .then(data => {
    // faça o que quiser com o resultado
  })

searchArtists(query)

Procure informações sobre Artistas. Teste em: Spotify Web Console com o tipo definido como artist.

Argumentos

Argumento	Tipo	Opções
query	string	'Pesquise qualquer coisa'

Exemplo

searchArtists('Veil of Maya')
  .then(data => {
    // faça o que quiser com o resultado
  })

searchTracks(query)

Procure informações sobre Faixas. Teste em: Spotify Web Console com o tipo definido como track.

Argumentos

Argumento	Tipo	Opções
query	string	'Pesquise qualquer coisa'

Exemplo

searchTracks('Veil of Maya')
  .then(data => {
    // faça o que quiser com o resultado
  })

searchPlaylists(query)

Procure informações sobre Playlists. Teste em: Spotify Web Console com o tipo definido como playlist.

Argumentos

Argumento	Tipo	Opções
query	string	'Pesquise qualquer coisa'

Exemplo

searchPlaylists('Veil of Maya')
  .then(data => {
    // faça o que quiser com o resultado
  })

getAlbum(id)

Procure informações sobre um album especifico com seu determinado id. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
id	string	'Id especifico'

Exemplo

getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
  .then(data => {
    // faça o que quiser com resultado
  })

getAlbums(ids)

Procure informações sobre alguns albuns informando seus determinados id's. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
ids	Array de Strings	['id1', 'id2']

Examplo

getAlbum(['4aawyAB9vmqN3uQ7FjRGTy', '1A2GTWGtFfWp7KSQTwWOyo'])
  .then(data => {
    // faça o que quiser com o resultado
  })

getAlbumTracks(id)

Procure todas as faixas de um album informando seu id. Teste em: Spotify Web Console.

Argumentos

Argumento	Tipo	Opções
id	string	'Id especifico'

Exemplo

getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
  .then(data => {
    // faça o que quiser com o resultado
  })

Contribuições

Por favor leia CONTRIBUTING.md para detalhes sobre nosso código de conduta, e o processo para enviar pedidos de commit para nós.

Versionamento

Nós usamos SemVer para o versionamento. Para ver as versões disponíveis, visite as tags deste repositorio.

Autores

Darlan Caruso

Veja também a lista de contribuidores que participaram deste projeto.

Licença

Este projeto foi licenciado sobre o MIT - veja o arquivo LICENSE.md para mais detalhes.