Classseedcordv0.12.0

SlashHandler

Base class for a chat-input (slash) command handler.

Pass the route from the generated registry as the generic, the same string as @SlashRoute@SlashRoute, then read this.optionsthis.options for a single command or this.matchthis.match for several. Command authoring stays plain discord.js, seedcord codegenseedcord codegen reads its toJSON()toJSON() to type these options.

abstract class SlashHandler<
    Route extends keyof SlashOptionRegistry,
    Cache extends CacheType = "cached"
> extends InteractionHandler<ChatInputCommandInteraction<Cache>>

abstract class SlashHandler<
    Route extends keyof SlashOptionRegistry,
    Cache extends CacheType = "cached"
> extends InteractionHandler<ChatInputCommandInteraction<Cache>>

\@SlashRoute('ban')
class BanHandler extends SlashHandler<'ban'> {
    \@Catchable()
    async execute() {
        const target = this.options.getUser('target'); // User
        const reason = this.options.getString('reason'); // string | null
    }
}

\@SlashRoute('ban')
class BanHandler extends SlashHandler<'ban'> {
    \@Catchable()
    async execute() {
        const target = this.options.getUser('target'); // User
        const reason = this.options.getString('reason'); // string | null
    }
}

Member visibility

Filter class members by access level.

Showing members with Protected visibility and higher.

Properties

options

Methods

match()

Route

One or more route keys from SlashOptionRegistry, e.g. 'ban''ban' or 'ban' | 'kick''ban' | 'kick'.

Route extends keyof SlashOptionRegistry

Route extends keyof SlashOptionRegistry

Cache

The interaction cache state, 'cached''cached' by default.

Cache extends CacheType = 'cached'

Cache extends CacheType = 'cached'

options

The typed options for this command's route. Required options drop the null, choices narrow to their literal union, and only the getters for kinds this command actually uses appear. Use this.event.optionsthis.event.options directly for anything outside this view, such as narrowing a channel option by type.

protected options: SlashOptions<Route, Cache>

protected options: SlashOptions<Route, Cache>

match()

Run the arm for whichever command fired, when this handler is registered for several routes.

Provide one arm per route, keyed by its route string, and each arm receives that route's typed options. A missing arm is a compile error.

protected async match<Ret>(
    arms: SlashMatchArms<Route, Cache, Ret>
): Promise<Ret>

protected async match<Ret>(
    arms: SlashMatchArms<Route, Cache, Ret>
): Promise<Ret>

Parameter: arms

One handler per registered route, keyed by route string.