Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
discord.ts (discordx)
Create your discord bot by using TypeScript and decorators!
This module is an extension of discord.js, so the internal behavior (methods, properties, ...) is the same.
This library allows you to use TypeScript decorators on discord.js, it simplifies your code and improves the readability!
https://oceanroleplay.github.io/discord.ts/
For @typeit/discord, we have created fixes and new features. Likewise, We have also requested our fixes and new features on original package at OwenCalvin/discord.ts/pull/62.
But with discordx
we intend to provide latest upto date package to build bots with many features, such as multi-bot, simple commands, etc.
If you have any issues or feature requests, Open an issue at Github click here
@Bot
)@Command
to support v4 commands@Button @SelectMenu
@DefaultPermission
Maintained by @oceanroleplay
Package by @OwenCalvin
Discord has it's own command system now, you can simply declare commands and use Slash commands this way
import { Discord, Slash } from "discordx";
import { CommandInteraction } from "discord.js";
@Discord()
abstract class AppDiscord {
@Slash("hello")
private hello(
@SlashOption("text")
text: string,
interaction: CommandInteraction
) {
// ...
}
}
There is a whole system that allows you to implement complex slash/simple commands and handle interactions like button and select menu
@Bot
@Button
@Command
@CommandOption
@DefaultPermission
@Description
@Discord
@Guard
@Guild
@On
@Once
@Permission
@SelectMenu
@Slash
@SlashChoice
@SlashGroup
@SlashOption
add button interaction handler for your bot using @Button
decorator
@Discord()
class buttonExample {
@Slash("hello")
async hello(interaction: CommandInteraction) {
const helloBtn = new MessageButton()
.setLabel("Hello")
.setEmoji("👋")
.setStyle("PRIMARY")
.setCustomId("hello-btn");
const row = new MessageActionRow().addComponents(helloBtn);
interaction.reply({
content: "Say hello to bot",
components: [row],
});
}
@Button("hello-btn")
mybtn(interaction: ButtonInteraction) {
interaction.reply(`👋 ${interaction.member}`);
}
}
add menu interaction handler for your bot using @SelectMenu
decorator
const roles = [
{ label: "Principal", value: "principal" },
{ label: "Teacher", value: "teacher" },
{ label: "Student", value: "student" },
];
@Discord()
class buttons {
@SelectMenu("role-menu")
async handle(interaction: SelectMenuInteraction) {
await interaction.defer();
// extract selected value by member
const roleValue = interaction.values?.[0];
// if value not found
if (!roleValue)
return await interaction.followUp("invalid role id, select again");
await interaction.followUp(
`you have selected role: ${
roles.find((r) => r.value === roleValue).label
}`
);
return;
}
@Slash("roles", { description: "role selector menu" })
async myroles(interaction: CommandInteraction): Promise<unknown> {
await interaction.defer();
// create menu for roels
const menu = new MessageSelectMenu()
.addOptions(roles)
.setCustomId("role-menu");
// create a row for meessage actions
const buttonRow = new MessageActionRow().addComponents(menu);
// send it
interaction.editReply({
content: "select your role!",
components: [buttonRow],
});
return;
}
}
Create a simple command handler for messages using @Command
. Example !hello world
@Discord()
class commandTest {
@Command("permcheck", { aliases: ["ptest"] })
@DefaultPermission(false)
@Permission({
id: "462341082919731200",
type: "USER",
permission: true,
})
async permFunc(message: CommandMessage) {
message.reply("access granted");
}
}
We can declare methods that will be executed whenever a Discord event is triggered.
Our methods must be decorated with the @On(event: string)
or @Once(event: string)
decorator.
That's simple, when the event is triggered, the method is called:
import { Discord, On, Once } from "discordx";
@Discord()
abstract class AppDiscord {
@On("messageCreate")
private onMessage() {
// ...
}
@Once("messageDelete")
private onMessageDelete() {
// ...
}
}
We implemented a guard system thats work pretty like the Koa middleware system
You can use functions that are executed before your event to determine if it's executed. For example, if you want to apply a prefix to the messages, you can simply use the @Guard
decorator.
The order of execution of the guards is done according to their position in the list, so they will be executed in order (from top to bottom).
Guards can be set for @Slash
, @On
, @Once
, @Discord
and globaly.
import { Discord, On, Client, Guard } from "discordx";
import { NotBot } from "./NotBot";
import { Prefix } from "./Prefix";
@Discord()
abstract class AppDiscord {
@On("messageCreate")
@Guard(
NotBot // You can use multiple guard functions, they are excuted in the same order!
)
async onMessage([message]: ArgsOf<"messageCreate">) {
switch (message.content.toLowerCase()) {
case "hello":
message.reply("Hello!");
break;
default:
message.reply("Command not found");
break;
}
}
}
Use npm or yarn to install discordx with discord.js
Please refer to the documentation
Simply join the Discord server
You can also find help with the examples folder
FAQs
Create a discord bot with TypeScript and Decorators!
The npm package discordx receives a total of 773 weekly downloads. As such, discordx popularity was classified as not popular.
We found that discordx demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.