Classgatewayv0.7.5

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, then read this.options for a single command or this.match for several. Command authoring stays plain discord.js, seedcord codegen reads its toJSON() to type these options.

abstract class SlashHandler<
    Route extends keyof SlashRegistry,
    Cache extends CacheType = CacheFor<Route>
> extends InteractionHandler<ChatInputCommandInteraction<Cache>>

\@SlashRoute('ban')
class BanHandler extends SlashHandler<'ban'> {
    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.

constructor

Constructs a new instance of the InteractionHandler class

InteractionHandler(
    event: Repliable,
    core: Core,
    dispatch: DispatchContext
)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Methods

buildSender()
defer()
delete()
edit()
execute()
followUp()
match()
reply()
send()
showModal()

Route

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

Route extends keyof SlashRegistry

Cache

The interaction cache state. The command's contexts set it.

Cache extends CacheType = CacheFor<Route>

core

readonly core: TCore

Inherited from:BaseHandler

dispatch

The bag for this dispatch. Each interaction gets its own. Every handler for one event shares a single bag.

protected readonly dispatch: DispatchContext

Inherited from:BaseHandler

event

protected readonly event: Event

Inherited from:BaseHandler

logger

protected readonly logger: Logger

Inherited from:BaseHandler

options

The typed options for this command's route. Only the getters for kinds this command declares appear. Each getter's name argument is restricted to that command's options of its kind.

A required option drops the null.
Choices narrow to their literal union.
A channel option declared with addChannelTypes narrows to those types.

Use this.event.options directly for anything outside this view, such as getSubcommand(). However, for the common case, the methods in this would suffice.

protected options: SlashOptions<Route, Cache>

routeId

protected readonly routeId: string

Inherited from:RepliableHandler

sender

The reply surface for this interaction. Pass the handler to reply from outside its class.

readonly sender: TSender

Inherited from:RepliableHandler

buildSender()

protected buildSender(
    event: Event,
    core: Core,
    dispatch: DispatchContext
): ReplySender

Inherited from:RepliableHandler

defer()

Show a "thinking" placeholder, then fill it later with edit.

protected async defer(opts?: DeferOpts): Promise<void>

Inherited from:RepliableHandler

delete()

Delete the initial reply or deferred placeholder. Pass a target to delete a message a prior send returned.

protected async delete(target?: TMessage): Promise<void>

Inherited from:RepliableHandler

edit()

Rewrite the initial reply or deferred placeholder. The targeted form rewrites a message a prior send returned.

protected async edit(
    response: ReplyResponse<TNative> | string
): Promise<TMessage>

Inherited from:RepliableHandler

execute()

Holds the main logic of your handler. The dispatcher calls it after the handler's gates pass, so a gate that refuses stops execute() from running.

abstract execute(): Promise<void>

Inherited from:BaseHandler

followUp()

Send a new message once the interaction is acknowledged.

protected async followUp(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage>

Inherited from:RepliableHandler

match()

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

Provide one arm per registered route, keyed by its route string, and each arm receives that route's own narrowed options. The arms must cover every route in the generic, a missing route or an unknown key is a compile error.

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

Parameter: arms

One handler per registered route, keyed by route string.

\@SlashRoute('ban', 'kick')
class ModHandler extends SlashHandler<'ban' | 'kick'> {
    async execute() {
        await this.match({
            ban: (options) => this.event.guild?.members.ban(options.getUser('target').id),
            kick: (options) => this.event.guild?.members.kick(options.getUser('member').id)
        });
    }
}

reply()

Send the initial response, exactly once.

protected async reply(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage>

Inherited from:RepliableHandler

send()

Routes to reply, followUp, or edit based on the current ack state.

protected async send(
    response: ReplyResponse<TNative> | string,
    opts?: SendOpts
): Promise<TMessage>

Inherited from:RepliableHandler

showModal()

Open a modal. Must be the initial response to this interaction. The modal kind rejects this call at compile time (Discord forbids a modal in response to a modal).

protected async showModal(
    this: InteractionHandler<NonModalInteraction>,
    modal: ModalLike
): Promise<void>

Inherited from:InteractionHandler