Commands.md

🡐 Back to README.md 🡐 Back to CommandHandler.md

Commands

You know what a command is. In string-commands, a command is an object.

let myCommand = {
    name: "hello",
    run: () => console.log("Hi!"),
}

The Properties

Basic Properties

• name: string: The name of the command
• run: (...RunnerArgs) => void: The runner function of the command
  • Whats the parameters? See runner args.
• aliases?: string[]: Optional aliases of the command

Non-standard:

These properties aren't used for the command handler, but is recommended for other plugins/middlewares etc:

• desc?: string: A short description
• category?: string: A category for your command

Arguments

The args property is an UsageResolvable[], which is explained more on here.

In short, you can supply the arguments of your command and string-commands will parse and validate them for you:

// Assume:
handler.buildArguments = ({ args, ctx }) => [args, ctx];

let myCommand = {
    name: "floor",
    desc: "Floors the number",
    args: ["number"],
    run: (args, ctx) => {
        // args[0] will always be a js number
        // if not, handler event 'invalidUsage' will be emitted
        ctx.reply(`Your floored number is ${Math.floor(args[0])}! :tada:`);
    }
}

Checks

Your commands can also have custom checks. Its recommended to make the checks once and reuse them for commands.

Command Checks are just the same as the runner functions, but they must return an object with these props:

• pass (boolean) - set to true if check succeeded
• message (string) - if it failed, the message explaining why

They can also be asynchronous

{
  checks: [
    (ctx, args) => {
      // Im an useless check! Gonna make it run!
      return { pass: true };
    },

    (ctx, args) => {
      // just you wait until you hear that im after you
      return {
        pass: false,
        message: "Hardcoded Failiure",
      };
    },
  ];
}

^ Back to top