Miscellaneous Examples

Conventions Used in Examples

Conventions are important - they are the agreements on which society functions. So let's take a moment to agree on a few.

Placeholders

A "Placeholder" is a piece of text that replaces something else. In these FAQs we assume the following variables as "placeholders" for your own:

• client is a placeholder that corresponds to your client variable, as we've covered at the end of the Getting Started guide. client.on("ready", () => { for example.

• message is a placeholder corresponds to your messageCreate event's variable which looks something like this: client.on("messageCreate", message => {.

Examples

awaitMessages

Example by: Lewdcario (84484653687267328)

This example sends a question and waits to receive a message response that says test.

message.channel.send("What tag would you like to see? This will await will be cancelled in 30 seconds. It will finish when you provide a message that goes through the filter the first time.")
.then(() => {
  message.channel.awaitMessages(response => response.content === "test", {
    max: 1,
    time: 30000,
    errors: ["time"],
  })
  .then((collected) => {
      message.channel.send(`The collected message was: ${collected.first().content}`);
    })
    .catch(() => {
      message.channel.send("There was no collected message that passed the filter within the time limit!");
    });
});

Creating a guild

Discord quietly changed the Create Guild API endpoint, small bots (10 guilds or fewer) are able to create guilds programmatically now. This example will have your bot create a new guild and create a role with the administrator permission, and the single line of code at the bottom will apply it to you when you execute it when you join the guild.

const { Permissions } = require("discord.js");

/* ES6 Promises */
client.guilds.create("Example Guild").then(guild => {
  guild.channels.cache.first().createInvite()
    .then(invite => client.users.cache.get("<USERID>").send(invite.url));
  guild.roles.create({ name: "Example Role", permissions: Permissions.FLAGS.ADMINISTRATOR })
    .then(role => client.users.cache.get("<UserId>").send(role.id))
    .catch(error => console.log(error))
});

/* ES8 async/await */
async function createGuild(client, message) {
  const { Permissions } = require("discord.js");
  try {
    const guild = await client.guilds.create("Example Guild");
    const defaultChannel = guild.channels.cache.find(channel => channel.permissionsFor(guild.me).has(Permissions.FLAGS.SEND_MESSAGES));
    const invite = await defaultChannel.createInvite();
    await message.author.send(invite.url);
    const role = await guild.roles.create({ name: "Example Role", permissions: Permission.FLAGS.ADMINISTRATOR });
    await message.author.send(role.id);
  } catch (e) {
    console.error(e);
  }
}
createGuild(client, message);
// Run this once you've joined the bot created guild.
message.member.roles.add("<THE ROLE ID YOU GET SENT>");

Command Cooldown

Example by ItsJordan#4297

Adds a cooldown to your commands so the user will have to wait 2.5 seconds between each command.

You can change the nature of the cool down by changing the return to something else.

// First, this must be at the top level of your code, **NOT** in any event!
const talkedRecently = new Set();

// Inside your messageCreate event, this code will stop any command during cooldown.
// Should be placed after your code that checks for bots & prefix, for best performance

if (talkedRecently.has(message.author.id))
  return;

// Adds the user to the set so that they can't talk for 2.5 seconds
talkedRecently.add(message.author.id);
setTimeout(() => {
  // Removes the user from the set after 2.5 seconds
  talkedRecently.delete(message.author.id);
}, 2500);

Mention Prefix

Regex or Regular Expressions are used to match character combinations in strings. Read more about them here. You can create and test them here

Requiring a little bit of regex, this will catch when a message starts with the bot being mentioned.

client.on("messageCreate", message => {
  const prefixMention = new RegExp(`^<@!?${client.user.id}> `);
    const prefix = message.content.match(prefixMention) ? message.content.match(prefixMention)[0] : '!';

  // Go ahead with the rest of your code!
});

Multiple Prefixes

Let's make it 3 prefixes, this is fairly universal. This could also be in the config.json once you get there. So we'll start by finding if the message content starts with either of the prefixes mentioned in the array. If it doesn't, we return.

client.on("messageCreate", message => {
  const prefixes = ["!", "?", "/"];
  const prefix = prefixes.find(p => message.content.startsWith(p));
  if (!prefix) return;

  // Go ahead with the rest of your code!
});

Multiple Prefixes Extension

client.on("messageCreate", async message => {
  const prefixes = ["!", "\\?", "\\/", `<@!?${client.user.id}> `];
  const prefixRegex = new RegExp(`^(${prefixes.join("|")})`);
  const prefix = message.content.match(prefixRegex);

  // Go ahead with the rest of your code!
});

Purging a Channel

Example by Hindsight (139412744439988224)

Example usage: !purge @user 10 , or !purge 25

const user = message.mentions.users.first();

if (!/^\d+$/.test(message.content.split(" ")[1])) return message.reply('Please provide a valid number');
// Check if the provided argument is completely a number. We run this because parseInt can parse numbers like this 564gb, leading to some undesirable results

// Parse Amount
const amount = !!parseInt(message.content.split(" ")[1]) ? parseInt(message.content.split(" ")[1]) : parseInt(message.content.split(" ")[2])

if (!amount) return message.reply("Must specify an amount to delete!");
if (!amount && !user) return message.reply("Must specify a user and amount, or just an amount, of messages to purge!");
// Fetch 100 messages (will be filtered and lowered up to max amount requested)
message.channel.messages.fetch({
 limit: 100,
}).then((messages) => {
 if (user) {
 const filterBy = user ? user.id : Client.user.id;
 messages = messages.filter(m => m.author.id === filterBy).array().slice(0, amount);
 }
 message.channel.bulkDelete(messages).catch(error => console.log(error.stack));
});

Swear Detector

This quick & dirty swear detector takes an array of swear words we don't want to see, and triggers on it.

const swearWords = ["darn", "shucks", "frak", "shite"]; // Make sure all of the words are lowercased only.
if (swearWords.forEach(word => message.content.toLowerCase().includes(word.toLowerCase()))) { // Lowercase the message content for better matching
  message.reply("Oh no you said a bad word!!!");
  // Or just do message.delete();
}

Kicking users (or bots) from a voice channel

Support for kicking members from voice channels has now been added by Discord and can be achieved by doing the following.

const { Permissions } = require("discord.js");

// Make sure the bot user has permissions to move members in the guild:
if (!message.guild.me.permissions.has(Permissions.FLAGS.MOVE_MEMBERS)) return message.reply("Missing the required `Move Members` permission.");

// Get the mentioned user/bot and check if they're in a voice channel:
const member = message.mentions.members.first();
if (!member) return message.reply("You need to @mention a user/bot to kick from the voice channel.");
if (!member.voice.channel) return message.reply("That user/bot isn't in a voice channel.");

// Now we set the member's voice channel to null, in other words disconnecting them from the voice channel.
member.voice.setChannel(null);

// Finally, pass some user response to show it all worked out:
message.react("👌");
/* or just "message.reply", etc.. up to you! */

This does the same as clicking the disconnect button on a user or bot while they are in a voice channel.