Commands

The command names are determined by their file name, here's a typical command structure:

src
└ commands
  ├ greet.ts # Will become /greet
  └ trivia.ts # Will become /trivia

This means that command file names must be globally unique.

Command execution

All commands are required to have a default export, this function is how your command will be handled.

src / commands / greet.ts

import type { CommandInteraction } from "dressed";
 
export default async function (interaction: CommandInteraction) {
  await interaction.reply("Hi there!");
}

Autocomplete

For some command options, you want to enable autocomplete. To create a handler for those interactions, you can simply export a function named autocomplete!

import { CommandOption, type CommandAutocompleteInteraction, type CommandConfig } from "dressed";
 
export const config = {
  description: "Send a random adorable animal photo",
  options: [
    CommandOption({
      type: "String",
      name: "animal",
      description: "The type of animal",
      required: true,
      autocomplete: true,
    }),
  ],
} satisfies CommandConfig;
 
export function autocomplete(interaction: CommandAutocompleteInteraction) {
  // sendChoices returns the options for them to select from
  interaction.sendChoices([
    { name: "Dog", value: "dog" },
    { name: "Cat", value: "cat" },
  ]);
}

Context commands

Context commands are super easy to enable, all you have to do is set the type in your command config to Message, User, or PrimaryEntryPoint. The CommandInteraction type is generic, so you can match it to show the correct data.

src / commands / get-avatar.ts

import type { CommandConfig, CommandInteraction } from "dressed";
 
export const config = { type: "User" } satisfies CommandConfig;
 
export default function avatar(interaction: CommandInteraction<typeof config>) {
  const user = interaction.target;
  return interaction.reply(`https://cdn.discordapp.com/avatars/${user.id}/${user.avatar}`);
}