discordblacklist

discordblacklist

A nodejs package that facilitates getting banned Discord users from DiscordBans

Installing via NPM.

$ npm install discordblacklist

Setup and functions.

Creating the object:

const Blacklist = require('discordblacklist'),
banlist = new Blacklist('token');

Get a token here.

The object will try to update its banlist on creation, however you can update the list manually at any time.

To update the ban list manually: banlist.update();

This returns a promise, and you can get the ban list from it with either the thenable or banlist.list or the thenable of banlist.array().

It is recommended you update your ban list every two hours

You can have the blacklist autoupdate the list like so:

const banlist = new Blacklist('token', true, 2*60);

To specify your own auto-update interval, create your object like so:

new Blacklist('token', true, minutes);

Clearing and resetting your auto-updater

To clear the autoupdater simply call banlist.stopUpdateTimer();. To then set a new one do banlist.setUpdateTimer(minutes).

Looking up users.

banlist.lookup("id") where id is the userid of the user you want to check. This returns a boolean depending on if the user is on the ban list.

Changing token

If for whatever reason you would like to switch tokens mid-execution, you can do that easily by calling banlist.changeToken('newtoken');

Summary example:

//Create the object (which autorefreshes the banlist every 120 minutes)
const Blacklist = require('discordblacklist');
let banlist = new Blacklist('token', true, 120);

//Someone's id to test
const someID = '1234567890';

//Check if they are on the banlist - Returns a true/false , or throws an error if an error occurred.
let isOnTheBanList = banlist.lookup(someID);

//Get the full list in string form. Must be used after update() has completed
console.log(banlist.list);

//Promise resolves the full list as an array. Can be called before update() is completed. Await will throw an error if an error occurred.
console.log(await banlist.array());

//Manually update the ban list:
let theUpdatedList = await banlist.update();