A JS API for SpookVooper
Go to file
Quinn Lane 51315c26e0
Merge remote-tracking branch 'origin/development' into development
2021-06-15 11:36:55 -04:00
.github Add a greeter workflow 2021-01-09 23:13:02 -05:00
.idea Add package.json key-value pairs for inbuilt typings and exports 2021-06-15 11:36:22 -04:00
.vscode 💻 Sync with local 2020-12-15 00:41:13 -05:00
src Add package.json key-value pairs for inbuilt typings and exports 2021-06-15 11:36:22 -04:00
typings Add package.json key-value pairs for inbuilt typings and exports 2021-06-15 11:36:22 -04:00
.eslintrc.json 💻 New sync 2020-12-08 15:50:31 -05:00
.gitignore Add package.json key-value pairs for inbuilt typings and exports 2021-06-15 11:36:22 -04:00
LICENSE Add package.json key-value pairs for inbuilt typings and exports 2021-06-15 11:36:22 -04:00
README.md Update README.md 2020-11-27 19:31:00 -05:00
SECURITY.md Add package.json key-value pairs for inbuilt typings and exports 2021-06-15 11:36:22 -04:00
package-lock.json Add package.json key-value pairs for inbuilt typings and exports 2021-06-15 11:36:22 -04:00
package.json Add package.json key-value pairs for inbuilt typings and exports 2021-06-15 11:36:22 -04:00
routes.md 📲 Update to v1.2.0-Stable (Axios) 2020-11-08 18:11:34 -05:00
tsconfig.json Add package.json key-value pairs for inbuilt typings and exports 2021-06-15 11:36:22 -04:00

README.md

SpookVooper API Library

Library that is used to easily access the SpookVooper API.

Usage

We use ES6 modules, because CommonJS makes me want to cry. If anything returns a JSON object, you need to use it as an array.

Example Script:

import svAPI from "spookvooperapi";
let a;

// Get the balance of SpikeViper, and save it to a variable, then console.log it with a prefix
svAPI.eco.getBalance("2a0057e6-356a-4a49-b825-c37796cb7bd9", true).then(value => {
    a = value;
    console.log(`Spike's Balance: ${a}`);
});

The value variable is what the function returns as a result. It gets passed to the callback function where you can use it.

The wiki is getting worked on constantly, but it will take a while so in the meantime, you can use the inline wiki. To use this feature we recommend people use Visual Studio Code.

Supported Routes

We support all the routes. We even made some in premade.

  • Auth
  • User
  • Group
  • Eco
  • Premade