https://github.com/wzhouwzhou/discordblacklist

The Featured Nodejs package that facilitates getting banned Discord users from DiscordBans.
https://github.com/wzhouwzhou/discordblacklist

bans discord nodejs promise-support

Last synced: 2 months ago
JSON representation

The Featured Nodejs package that facilitates getting banned Discord users from DiscordBans.

• Host: GitHub
• URL: https://github.com/wzhouwzhou/discordblacklist
• Owner: wzhouwzhou
• License: agpl-3.0
• Created: 2017-06-17T02:20:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-08-22T21:59:42.000Z (over 6 years ago)
• Last Synced: 2024-02-09T15:13:17.340Z (11 months ago)
• Topics: bans, discord, nodejs, promise-support
• Language: JavaScript
• Homepage: https://npmjs.com/discordblacklist
• Size: 715 KB
• Stars: 10
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    


    


        

        

        

        

        

        

    

    


        

    



# Discordblacklist

## The Featured Nodejs package that facilitates getting banned Discord users from DiscordBans.

### Installing via NPM.

```$ npm install --save [email protected] --only=production```

**Note: Version 3.2.x package API has changed from previous versions, all previous versions below 3.x are deprecated following a rewrite of the discordbans api as well as changed domains and removed features.**

Version 3.2.x now allows you to bulk lookup **more than 99 users at once**.

**Why discordblacklist?**

• Fast, Light, and No bloat (Yes! Actually works with No other dependencies!), packed size is ~15kB

• Updated and Modern (Code standards and checks ensure code quality and aim for 0 vulnerabilities)

• Popular and Safe - the Oldest and Most Trusted Full-Coverage package with thousands of downloads, actively maintained by a verified DBans staff member.

### I'm sold! How do I begin?

    // Create the object

    const Blacklist = require('discordblacklist');

    const token = 'My-token';

    const blacklist = new Blacklist(token);

    // Someone's id to test

    const someID = '1234567890';

    // Raw data from the banlist

    let data = await blacklist.lookup(someID);

    console.log(data);

    // No await:

    blacklist.lookup(someID).then(result => console.log(result));

    // Boolean they are on the banlist:

    let onTheList = await blacklist.isBanned(someID);

    console.log(onTheList);

    // No await:

    blacklist.isBanned(someID).then(result => console.log(result));

    // Bulk lookup several users (no maximum user count to lookup at once!)

    const ids = ['12345', '123456', '1234567'];

    data = await blacklist.bulkLookup(ids);

    // No await:

    blacklist.bulkLookup(ids).then(result => console.log(result));

    // Bulk lookup, but get the results mapped by user_id

    const mapdata = await bulkLookupMap(ids);

**Changing token**

If for whatever reason you would like to switch tokens, you can do that easily by calling.

```blacklist.changeToken('newtoken');```

This work is ©Copyright under the `GNU AFFERO GENERAL PUBLIC LICENSE Version 3`. See LICENSE for more details.

Enjoy this package? Consider starring on [github](https://github.com/wzhouwzhou/discordblacklist) and checking out some of my other work:

[Youtube Search API](https://npmjs.com/ytsearcher)

[Fluent Filepaths](https://npmjs.com/easypathutil)

[Urban Dictionary](https://npmjs.com/easyurban)

Contact William Zhou#0001 via https://discord.gg/jj5FzF7 for more information.