discord-id

1.1.0 • Public • Published

DiscordID

Convenient solution for fetching a Discord user profile.

Maintainability CodeFactor NPM Weekly Downloads

Errors

These are the possible errors you could run into.

# Code Message Meaning
1 0 401: Unauthorized You didn't enter a valid bot token.
2 10013 Unknown User The user ID you submitted doesn't match anyone.

Usage Examples

Load and ready the library.
const { Discord } = require("discord-id");

// A bot token is required for authorization.
const Client = new Discord("BOT_TOKEN");
Grab profile information.
// Despite the Discord user ID being an integer, when you
// input it here, make sure it's a string otherwise you risk
// receiving an error.
Client.grabProfile("236123737525583872").then(User =>
{
    console.log(User);

    /**
     * { id: '236123737525583872',
     * username: 'Jin',
     * avatar:
     *  { hash: 'c0b547d5a6c43dc60bbdb3b2a5cfd872',
     *    format: 'png',
     *    url: 'https://cdn.discordapp.com/avatars/236123737525583872/c0b547d5a6c43dc60bbdb3b2a5cfd872.png?size=1024' },
     * discriminator: '8303',
     * public_flags: 768,
     * creation_stamp: 1476366685993,
     * badges:
     *  [ { id: 256, name: 'House Balance' },
     *    { id: 512, name: 'Early Supporter' } ] }
     */
}).catch(Error => {
    /**
     * ERROR HANDLING LOGIC HERE
     */
});
How to use the badges data.

This is only a rudimentary example for demonstration purposes. Feel free to use your own implementation.

Client.grabProfile("236123737525583872").then(User =>
{
    let Badges = [];

    for (var i = 0; i < User.badges.length; i++)
    {
        Badges.push(User.badges[i].name);
    }

    console.log(`These are the user's badges: ${Badges.join(", ")}`);

    /**
     * These are the user's badges: House Balance, Early Supporter
     */
}).catch(console.error);

License

This software is released as-is, for free and open-source under the Apache 2.0 license.

Copyright 2021 Khalil G.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Readme

Keywords

Package Sidebar

Install

npm i discord-id

Weekly Downloads

21

Version

1.1.0

License

Apache-2.0

Unpacked Size

20.1 kB

Total Files

6

Last publish

Collaborators

  • jinzulen