Controllers

Controllers are the foundation of your application's business logic. The are responsible for handling the interaction, they are the final destination of the interaction.

---

discord.js-mvc doesn't provide any built-in controllers, but it provides a way to create and type your own controllers.

There are 2 methods to create a controller:

1. You can manually create a controller function and pass it to the Route class.
2. You can use the generate command to generate a controller file and then export the controller function from it.

djs-mvc generate controller ping
# or
djs-mvc g c ping

Controller

A controller is a function that will be executed when the route is triggered. It can be an anonymous function or a function that you create in a separate file. We strongly recommend using a separate file for each controller. This way you can easily manage your controllers.

Anonymous function

new Route<Context<ButtonInteraction>>('ping', async (ctx) => {
    await ctx.interaction.reply('pong')
})

Separate file

// controllers/ping.ts
export const pingController:Controller<Context<CommandInteraction>> = async (ctx) => {
    await ctx.interaction.reply('pong')
}

Controller types and generics

Typeing the controller function is optional, but it is recommended. It makes easier to work with the interaction as the default interaction type is Interaction and it can become frustrating to check the type of the interaction every time.

client.on(Events.InteractionCreate, (interaction)=>{
    if(interaction.isButton()){
        // interaction is ButtonInteraction
    }else if(interaction.isCommand()){
        // interaction is CommandInteraction
    }
    // ...
})

To avoid this, you can type the controller function and provide the type of the interaction as a generic type of the Route class in case of anonymous function or as a generic type of the Controller type in case of separate file. The type of the interaction is provided by the Context<{InteractionType}> type.

// anonymous function
new Route<Context<ButtonInteraction>>('ping', async (ctx) => {
    await ctx.interaction.reply('pong')
})
// separate file
export const pingController: Controller<Context<ButtonInteraction>> = async (interaction) => {
    await ctx.interaction.reply('pong')
}