TheModdedChicken / djs-util

A command handler library for Discord.js

djs-util

A command handler library for Discord.js

NOTE: This library is still under development and does not have a stable release version

Install

This package can be installed using npm or yarn:

npm install tmc-djs-util@beta or yarn add tmc-djs-util@beta

Usage

Basic usage goes as follows.

import { Client, Intents } from 'discord.js'
import { SlashCommandHandler } from 'tmc-djs-util'

const client = new Client({ intents: [Intents.FLAGS.GUILDS] });

const slashCommandHandler = new SlashCommandHandler(client, "012345678912345678", "botToken", {
	directories: ["path/to/commands"]
})

SlashCommandHandler Options

• directories: string[] - List of directories to search through
• guild_id: string - ID of guild to handle commands on
• refresh: boolean - Refresh commands on startup (Global commands might take longer to refresh)

Slash Command File

A slash command file needs to have data and command exposed by default.

• data: SlashCommandBuilder - An instance of SlashCommandBuilder from '@discordjs/builders'
• command: (interaction: CommandInteraction) => Promise<void> - The main process of your command
• autocomplete?: (interaction: AutocompleteInteraction) => Promise<void>
• button?: (interaction: ButtonInteraction) => Promise<void>
• contextMenu?: (interaction: ContextMenuInteraction) => Promise<void>
• messageContextMenu?: (interaction: MessageContextMenuInteraction) => Promise<void>
• userContextMenu?: (interaction: UserContextMenuInteraction) => Promise<void>

Example command:

import { SlashCommandBuilder } from "@discordjs/builders";
import { CommandInteraction } from "discord.js";

export default {
  data: new SlashCommandBuilder().setName('ping').setDescription("Check the bot's ping"),
  
  async command(interaction: CommandInteraction) {
    const time = new Date().getTime() - interaction.createdAt.getTime();
    interaction.reply(`Pong! (${time}ms)`);
  }
}

Middleware

Command handler middleware acts as a way to verify an interaction using your own code and stop processing the interaction if it doesn't meet your requirements.

Here's a basic middleware that stops the interaction if it's a button:

slashCommandHandler.middleware((i, stop) => {
	if (i.isButton()) stop();
})