Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpedroschmitz/simple-spotify-wrapper
:loud_sound: A small and awesome wrapper to get general information from the Spotify Web API.
https://github.com/jpedroschmitz/simple-spotify-wrapper
javascript library spotify spotify-web-api tdd wrapper-api
Last synced: 3 months ago
JSON representation
:loud_sound: A small and awesome wrapper to get general information from the Spotify Web API.
- Host: GitHub
- URL: https://github.com/jpedroschmitz/simple-spotify-wrapper
- Owner: jpedroschmitz
- License: mit
- Created: 2019-03-11T12:13:11.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T00:42:40.000Z (about 2 years ago)
- Last Synced: 2024-10-04T15:22:01.932Z (4 months ago)
- Topics: javascript, library, spotify, spotify-web-api, tdd, wrapper-api
- Language: JavaScript
- Homepage:
- Size: 673 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Simple Spotify Wrapper
[](https://travis-ci.org/jpedroschmitz/simple-spotify-wrapper) [](https://coveralls.io/github/jpedroschmitz/spotify-wrapper?branch=master)
A small and awesome wrapper to get general information from the [Spotify Web API](https://developer.spotify.com/documentation/web-api/).
## Installation
You can install the library using `npm`:
```sh
$ npm i simple-spotify-wrapper
```
or using `yarn`:
```sh
$ yarn add simple-spotify-wrapper
```
## How to use
### ES6
```js
// import the library
import SpotifyWrapper from 'simple-spotify-wrapper';
// create a instance
const spotify = new SpotifyWrapper({
token: 'PUT YOUR TOKEN HERE'
});
const albums = spotify.search.albums('Choose your artist');
albums.then(data => console.log(data.albums));
```
### CommonJS
```js
var spotifyWrapper = require('spotify-wrapper');
```
### UMD in Browser
```html
```
After that the library will be available to the Global as `SpotifyWrapper`. Check this example:
```js
const spotify = new SpotifyWrapper({
token: 'PUT YOUR TOKEN HERE'
});
const albums = spotify.search.albums('Choose your artist');
albums.then(data => console.log(data.albums.items));
```
## Methods
Below are all the methods that the library provide:
- [search.artists(query)](#searchartistsquery)
- [search.albums(query)](#searchalbumsquery)
- [search.tracks(query)](#searchtracksquery)
- [search.playlists(query)](#searchplaylistsquery)
- [album.getAlbum(id)](#albumgetalbumid)
- [album.getAlbums(ids)](#albumgetalbumsids)
- [album.getTracks(id)](#albumgettracksid)
### search.artists(query)
> Search for informations about Artists with provided query. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-search-item/) with type defined as *artist*.
**Arguments**
| Argument | Type | Options |
|----------|---------|-------------------|
|`query` |*string* | 'Any search query'|
**Example**
```js
search.artists('Isadora Pompeo')
.then(data => {
// do what you want here
})
```
#### [⇯ go back](#methods)
### search.albums(query)
> Search for informations about Albums with provided query. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-search-item/) with type defined as *album*.
**Arguments**
| Argument | Type | Options |
|----------|---------|-------------------|
|`query` |*string* | 'Any search query'|
**Example**
```js
spotify.search.albums('Isadora Pompeo')
.then(data => {
// do what you want here
})
```
#### [⇯ go back](#methods)
### search.tracks(query)
> Search for informations about Tracks with provided query. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-search-item/) with type defined as *track*.
**Arguments**
| Argument | Type | Options |
|----------|---------|-------------------|
|`query` |*string* | 'Any search query'|
**Example**
```js
spotify.search.tracks('Isadora Pompeo')
.then(data => {
// do what you want here
})
```
#### [⇯ go back](#methods)
### search.playlists(query)
> Search for informations about Playlists with provided query. Test in [Spotify Web Console](https://developer.spotify.com/web-api/console/get-search-item/) with type defined as *playlist*.
**Arguments**
| Argument | Type | Options |
|----------|---------|-------------------|
|`query` |*string* | 'Any search query'|
**Example**
```js
spotify.search.tracks('Isadora Pompeo')
.then(data => {
// do what you want here
})
```
#### [⇯ go back](#methods)
### album.getAlbum(id)
> Search for informations about a specific Album with a id.
**Arguments**
| Argument | Type | Options |
|----------|---------|-------------------|
|`id` |*string* | 'Specific id'|
**Example**
```js
spotify.album.getAlbum('4aawyAB9vmqN3uQ7FjRGTy')
.then(data => {
// do what you want here
})
```
#### [⇯ go back](#methods)
### album.getAlbums(ids)
> Search for informations about a specific Album with their ids.
**Arguments**
| Argument | Type | Options |
|----------|---------|-------------------|
|`ids` |*Array of strings* | ['id1', 'id2'] |
**Example**
```js
spotify.album.getAlbums(['4aawyAB9vmqN3uQ7FjRGTy', '1A2GTWGtFfWp7KSQTwWOyo'])
.then(data => {
// do what you want here
})
```
#### [⇯ go back](#methods)
### album.getTracks(id)
> Search for all tracks from a specific album.
**Arguments**
| Argument | Type | Options |
|----------|---------|-------------------|
|`id` |*string* | 'Specific id'|
**Example**
```js
spotify.album.getTracks('4aawyAB9vmqN3uQ7FjRGTy')
.then(data => {
// do what you want here
})
```
#### [⇯ go back](#methods)
## Browser Support
This library relies on [Fetch API](https://fetch.spec.whatwg.org/). And this API is supported in the following browsers.
 |  |  |  |  |
--- | --- | --- | --- | --- |
42+ ✔ | 39+ ✔ | 29+ ✔ | 10.1+ ✔ | Nope ✘ |
## Dependencies
This library depends on [fetch](https://fetch.spec.whatwg.org/) to make requests to the Spotify Web API. For environments that don't support fetch, you'll need to provide a [polyfill](https://github.com/github/fetch) to browser or [polyfill](https://github.com/bitinn/node-fetch) to node.
## Testing
To run the tests you can use the following command inside the project folder:
```sh
npm test
```
Or if you want to test the coverage use:
```sh
npm run test:coverage
```
## Projects using the library
> If you want to submit your application read the [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
- [Spotify Player](https://github.com/jpedroschmitz/spotify-player)
## Upcoming methods :)
If you want to help in the project or see the upcoming methods check this [link](https://github.com/jpedroschmitz/simple-spotify-wrapper/issues/1).
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
## Project License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.
## Authors
| |
|:---------------------:|
| [João Pedro Schmitz](https://github.com/jpedroschmitz/) |