Validations Setup

Validations are functions that are called before the run function from a command object is called. They can be used for many things, including validating your command object, or even implementing features such as cooldowns where the user will not be able to run the command if a validation functions says so.

Validation functions are called on every command trigger, so it's important to keep them as lightweight as possible.

info

Custom validation functions are called before the built-in validations provided by CommandKit. This provides you with more control over the flow of commands.

CommonJS

src/validations/cooldowns.js

const cooldowns = require('../cooldowns-cache');

module.exports = ({ interaction, commandObj, handler }) => {
  if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
    interaction.reply({
      content: "You're on cooldown, please wait some time before running this command again.",
      ephemeral: true,
    });

    return true; // This is important
  }
};

ESM

src/validations/cooldowns.js

import cooldowns from '../cooldowns-cache';

export default function ({ interaction, commandObj, handler }) {
  if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
    interaction.reply({
      content: "You're on cooldown, please wait some time before running this command again.",
      ephemeral: true,
    });

    return true; // This is important
  }
};

TypeScript

src/validations/cooldowns.ts

import type { ValidationProps } from 'commandkit';
import cooldowns from '../cooldowns-cache';

export default function ({ interaction, commandObj, handler }: ValidationProps) {
  if (cooldowns.has(`${interaction.user.id}-${commandObj.data.name}`)) {
    interaction.reply({
      content: "You're on cooldown, please wait some time before running this command again.",
      ephemeral: true,
    });

    return true; // This is important
  }
};

Parameters explained

Within every validation function, you have the ability to check what command is trying to be executed using commandObj and the interaction object from the parameters and respond accordingly.

The commandObj object is what's being exported from your command file (excluding the run function). This means you can access the data and options property from within your validation function.

The handler object is the current CommandKit instance.

Stopping the command from running

You may notice that the code above is returning true. This is important as it tells the command handler to not run any other validations and to not run the command. If you do not return true (or any truthy value), the command will run as normal.

warning

Interactions (commands in this case) must be handled within 3 seconds, so make sure your validations are not using up much of that time. If you're using a database or an external API, it's recommended to implement caching to keep things quick.