Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.01 KB

README.md

File metadata and controls

35 lines (21 loc) · 1.01 KB

beatsaver-api-wrapper

An api wrapper for Beatsaver.

Info

Currently supports all get api endpoints specified by the Beatsaver api docs. (https://api.beatsaver.com/docs/index.html?url=./swagger.json)
OAuth/post endpoints will be coming soon.

Installation

The package is available on npm. You can install it using this command:

npm install beatsaver-api-wrapper

Documentation

Documentation is available on this repository's wiki.

Tests and test dependencies

Run npm i and npm test to run all tests.
Uses mocha and nock for testing.

  • mocha - API wrapper tests
  • nock - Test network errors

Dependencies

Only uses axios for http requests so it should work in the browser. (not tested yet)