aknorw / discojs

Easiest way to use the Discogs API in Javascript/Typescript :musical_note:
https://aknorw.github.io/discojs
MIT License
63 stars 9 forks source link
api client discogs javascript typescript

Discojs

Easiest way to use the Discogs API in Javascript - now with Typescript support! :musical_note:

CircleCI Coverage Status

Installation

yarn add discojs

Usage example

import {Discojs} from 'discojs'

const client = new Discojs({
  userToken: process.env.USER_TOKEN,
})

client
  .searchArtist('Jacob Desvarieux')
  .then(data => doSomethingWith(data))

API Reference

v2

Documentation for discojs@2.x is available on GitHub Pages;

v1

Documentation for discojs@1.x is available in the wiki.

Tests

As several methods need authentication, you'll need 2 environment variables: _DGSUSERNAME and _USERTOKEN.

Create a .env file at the root of the directory, and add the following lines:

DGS_USERNAME=0ctocat
USER_TOKEN=7h1515myu53r70k3n

:warning: Use a test account as public information will be edited.

As stated by Discogs API, some methods need a seller account. As I do not have one, I could not test them (which explains the coverage).

npm run test

When running tests, go grab a cup of coffee as this may be long because of Discogs API rate limiting.

Credits

Inspired by disconnect from @bartve