Options

import { command, option } from "spearkit";

command({
  name: "profile",
  description: "Show a profile",
  options: {
    user: option.user({ description: "Whose profile", required: true }),
    detailed: option.boolean({ description: "Show extra detail" }),
  },
  run: (ctx) => {
    ctx.options.user;     // User
    ctx.options.detailed; // boolean | undefined
  },
});

{
  description: string;                        // required
  required?: boolean;                         // default: false
  nameLocalizations?: LocalizationMap;
  descriptionLocalizations?: LocalizationMap;
}

options: {
  // required → the value type, never undefined
  name: option.string({ description: "Name", required: true }),     // string

  // optional (default) → value | undefined
  age: option.integer({ description: "Age" }),                      // number | undefined

  // choices → a literal union of the choice values
  size: option.string({
    description: "Size",
    choices: [
      { name: "Small", value: "sm" },
      { name: "Large", value: "lg" },
    ],
  }),                                                               // "sm" | "lg" | undefined
}

run: (ctx) => {
  const name: string = ctx.options.name;
  const age: number | undefined = ctx.options.age;
  const size: "sm" | "lg" | undefined = ctx.options.size;
};

options: {
  count: option.integer({ description: "How many", minValue: 1, maxValue: 100 }),
  code: option.string({ description: "Code", minLength: 4, maxLength: 8 }),
}

import { option, ChannelType } from "spearkit";

options: {
  target: option.channel({
    description: "A text or announcement channel",
    channelTypes: [ChannelType.GuildText, ChannelType.GuildAnnouncement],
  }),
}

option.integer({
  description: "Priority",
  choices: [
    { name: "Low", value: 1 },
    { name: "High", value: 2 },
  ],
  // optional per-choice localization:
  // choices: [{ name: "Low", value: 1, nameLocalizations: { tr: "Düşük" } }],
}); // 1 | 2 | undefined

const fruits = ["apple", "apricot", "banana", "cherry"];

option.string({
  description: "Fruit",
  required: true,
  autocomplete: (ctx) =>
    fruits
      .filter((f) => f.startsWith(ctx.value))
      .map((f) => ({ name: f, value: f })),
});