Command Options

Options are defined in your command config and are filled in by users to be sent with the interaction.

You can access options using the getOption function on interaction. While it isn't required, including your command's config in the type will unlock name autocomplete and smart function determination in getOption.

import { type CommandConfig, type CommandInteraction, CommandOption } from "dressed";
 
export const config = {
  options: [
    CommandOption({
      name: "required",
      description: "This is required",
      type: "String",
      required: true,
    }),
    CommandOption({
      name: "optional",
      description: "This is optional",
      type: "String",
    }),
  ],
} satisfies CommandConfig;
 
export default function (interaction: CommandInteraction<typeof config>) {
  const required = interaction.getOption("required", true).string(); // string
  const optional = interaction.getOption("optional")?.string(); // string | undefined
}

A required option will throw an error if it's missing.

Subcommands

Subcommands are a special type of option as they can contain further options, while they do have the required prop in the CommandOption function, Discord will fail if you try to use it.

import { type CommandConfig, type CommandInteraction, CommandOption } from "dressed";
 
export const config = {
  options: [
    CommandOption({
      name: "foo",
      description: "A subcommand",
      type: "Subcommand",
      options: [
        CommandOption({
          name: "baz",
          description: "Enter a big number",
          type: "Number",
          required: true,
        }),
      ],
    }),
    CommandOption({
      name: "group",
      description: "A subcommand group",
      type: "SubcommandGroup",
      options: [
        CommandOption({
          name: "bar",
          description: "Another subcommand",
          type: "Subcommand",
        }),
      ],
    }),
  ],
} satisfies CommandConfig;
 
export default function (interaction: CommandInteraction<typeof config>) {
  const subcommand =
    interaction.getOption("foo")?.subcommand() ||
    interaction.getOption("group")?.subcommandGroup().getSubcommand("bar");
 
  switch (subcommand?.name) {
    case "foo": {
      const baz = subcommand.getOption("baz", true).number();
      return interaction.reply(`${baz} is a pretty big number!`);
    }
    case "bar": {
      return interaction.reply("Bar");
    }
  }
}