README.md

Boats.js

The official https://discord.boats API wrapper for Node.js

Installation

Simply run npm i boats.js (or yarn add boats.js)

Usage

(Sync) Posting Stats:

const BOATS = require('boats.js');
const Boats = new BOATS('API TOKEN');

Boats.postStats('SERVER_COUNT', 'BOT_ID').then(() => {
    console.log('Successfully updated server count.');
}).catch((err) => {
    console.error(err);
});

Getting Bot Info:

const BOATS = require();
const Boats = new BOATS('API TOKEN');

Boats.getBot('BOT_ID').then(bot => {
    console.log(bot);
}).catch((err) => {
    console.error(err);
});

Getting User Info:

const BOATS = require('boats.js');
const Boats = new BOATS();

Boats.getUser('USER_ID').then(user => {
    console.log(user);
}).catch((err) => {
    console.error(err);
});

Checking if a user voted your bot:

const BOATS = require('boats.js');
const Boats = new BOATS('API TOKEN');

Boats.getVoted('BOT_ID', 'USER_ID').then((voted) => {
    console.log(voted);
}).catch((err) => {
    console.error(err);
});

(Async)

const BOATS = require('boats.js');
const Boats = new BOATS('API TOKEN', 'API VERSION (OPTIONAL, e.g "v2" or "v1")');

await Boats.postStats('SERVER_COUNT', 'BOT_ID');

Getting Bot Info:

const BOATS = require('boats.js');
const Boats = new BOATS();

console.log(await Boats.getBot('BOT_ID'));

Getting User Info:

const BOATS = require('boats.js');
const Boats = new BOATS();

console.log(await Boats.getUser('USER_ID'));

Checking if a user voted your bot:

const BOATS = require('boats.js');
const Boats = new BOATS();

console.log(await Boats.getVoted('BOT_ID', 'USER_ID'));