Slash Command Builders.md

Slash Command Builders

Ping command

import { SlashCommandBuilder } from '@discordjs/builders';

// Create a slash command builder
const pingCommand = new SlashCommandBuilder().setName('ping').setDescription('Check if this interaction is responsive');

// Get the raw data that can be sent to Discord
const rawData = pingCommand.toJSON();

Arguments

import { SlashCommandBuilder } from '@discordjs/builders';

// Creates a boop command
const boopCommand = new SlashCommandBuilder()
	.setName('boop')
	.setDescription('Boops the specified user, as many times as you want');

// Adds a user argument to the command
boopCommand.addUserOption((option) => option.setName('user').setDescription('The user to boop').setRequired(true));

// Adds an integer option
boopCommand.addIntegerOption((option) =>
	option.setName('boop_amount').setDescription('How many times should the user be booped (defaults to 1)'),
);

// Supports choices too!
boopCommand.addIntegerOption((option) =>
	option
		.setName('boop_reminder')
		.setDescription('How often should we remind you to boop the user')
		.addChoice('Every day', 1)
		.addChoice('Weekly', 7)
		// Or, if you prefer adding more choices at once, you can use an array
		.addChoices([
			['Every three months', 90],
			['Yearly', 365],
		]),
);

// Get the final raw data that can be sent to Discord
const rawData = boopCommand.toJSON();

Sub commands and sub command groups

import { SlashCommandBuilder } from '@discordjs/builders';

const pointsCommand = new SlashCommandBuilder().setName('points').setDescription('Lists or manages user points');

// Add a manage group
pointsCommand.addSubCommandGroup((group) =>
	group
		.setName('manage')
		.setDescription('Shows or manages points in the server')
		.addSubCommand((subCommand) =>
			subCommand
				.setName('user_points')
				.setDescription("Alters a user's points")
				.addUserOption((option) =>
					option.setName('user').setDescription('The user whose points to alter').setRequired(true),
				)
				.addStringOption((option) =>
					option
						.setName('action')
						.setDescription('What action should be taken with the users points?')
						.addChoices([
							['Add points', 'add'],
							['Remove points', 'remove'],
							['Reset points', 'reset'],
						])
						.setRequired(true),
				)
				.addIntegerOption((option) => option.setName('points').setDescription('Points to add or remove')),
		),
);

// Add an information group
pointsCommand.addSubCommandGroup((group) =>
	group
		.setName('info')
		.setDescription('Shows information about points in the guild')
		.addSubCommand((subCommand) =>
			subCommand.setName('total').setDescription('Tells you the total amount of points given in the guild'),
		)
		.addSubCommand((subCommand) =>
			subCommand
				.setName('user')
				.setDescription("Lists a user's points")
				.addUserOption((option) =>
					option.setName('user').setDescription('The user whose points to list').setRequired(true),
				),
		),
);

// Get the final raw data that can be sent to Discord
const rawData = pointsCommand.toJSON();