add spotify docs

This commit is contained in:
Sayem Chowdhury 2021-03-24 12:14:17 +06:00
parent f4a766c91d
commit 8b823b3533
1 changed files with 34 additions and 0 deletions

34
docs/spotify.md Normal file
View File

@ -0,0 +1,34 @@
## Spotify to Deezer
`d-fi-core` exports Spotify api to easily convert tracks, albums, artists and playlist to deezer via matching ISRC and UPC code.
## Usage
Here's a simple example. All method returns `Object` or throws `Error`. Make sure to catch error on your side.
```ts
import {spotify} from 'd-fi-core';
// Set token first to bypass some limits
await spotify.setSpotifyAnonymousToken();
// Convert single track to deezer
const track = await spotify.track2deezer(song_id);
console.log(track);
// Convert album and tracks to deezer
const [album, tracks] = await spotify.album2deezer(album_id);
console.log(album);
console.log(tracks);
// Convert playlist and tracks to deezer
const [playlist, tracks] = await spotify.playlist2Deezer(playlist_id);
console.log(playlist);
console.log(tracks);
// Convert artist tracks to deezer (limited to 10 tracks)
const tracks = await spotify.artist2Deezer(artist_id);
console.log(tracks);
```
Take a look at [`src/converter/spotify.ts`](https://github.com/d-fi/d-fi-core/blob/master/src/converter/spotify.ts) and [`__tests__/converter/spotify.ts`](https://github.com/d-fi/d-fi-core/blob/master/__tests__/converter/spotify.ts) to understand more.