Handling command errors

Search…
WOKCommands sends an error message by default, however you might want to customize this more and perhaps send an embed instead of a normal message. You can listen to command errors to achieve this.
Here is a list of all command errors you can listen for:
EXCEPTION
COOLDOWN
INVALID ARGUMENTS
MISSING PERMISSIONS
MISSING ROLES
COMMAND DISABLED
Each one will provide various pieces of information depending on what the error is. For example "MISSING ROLES" will provide a list of missing roles. "INVALID ARGUMENTS" will provide the arguments the user used in the command.
To listen to command errors you can pass an error function in your command object like so:
JavaScript
TypeScript
ping.js
1
const { MessageEmbed } = require('discord.js')
2
​
3
module.exports = {
4
  // Best practice for the built-in help menu
5
  category: 'Testing',
6
  description: 'Replies with "Pong!"',
7
​
8
  // Invoked when the command is actually ran
9
  callback: ({ message }) => {
10
    message.reply({
11
      content: 'Pong!'
12
    })
13
  },
14
  
15
  // Invoked when there is an error when running this command
16
  error: ({ error, command, message, info }) => {
17
    // "error" holds one of the strings mentioned in the above list
18
    if (error === 'COMMAND DISABLED') {
19
      // For example we can now create and send a custom embed
20
      const embed = new MessageEmbed()
21
        .setTitle('Command disabled')
22
        .setColor(0xff0000)
23
​
24
      message.reply({
25
        embeds: [embed]
26
      })
27
    }
28
  },
29
}
Copied!
ping.ts
1
import { MessageEmbed } from 'discord.js'
2
import { ICommand, CommandErrors } from 'wokcommands'
3
​
4
export default {
5
  // Best practice for the built-in help menu
6
  category: 'Testing',
7
  description: 'Replies with "Pong!"',
8
​
9
  // Invoked when the command is actually ran
10
  callback: ({ message }) => {
11
    message.reply({
12
      content: 'Pong!'
13
    })
14
  },
15
  
16
  // Invoked when there is an error when running this command
17
  error: ({ error, command, message, info }) => {
18
    // "error" holds one of the strings mentioned in the above list
19
    if (error === CommandErrors.COMMAND_DISABLED) {
20
      // For example we can now create and send a custom embed
21
      const embed = new MessageEmbed()
22
        .setTitle('Command disabled')
23
        .setColor(0xff0000)
24
​
25
      message.reply({
26
        embeds: [embed]
27
      })
28
    }
29
  },
30
} as ICommand
Copied!
Commands - Previous
Test servers
Next - Commands
Command cooldowns
Last modified 8mo ago
Copy link