Classseedcordv0.15.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'> {
    async execute() {
        const target = this.options.getUser('target'); // User
        const reason = this.options.getString('reason'); // string | null
    }
}

\@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 InteractionHandlerInteractionHandler class

InteractionHandler(event: Repliable, core: Core)

InteractionHandler(event: Repliable, core: Core)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Methods

execute()
match()

Route

One or more route keys from SlashOptionRegistrySlashOptionRegistry, 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'

core

readonly core: Core

readonly core: Core

Inherited from:BaseHandler

event

protected readonly event: ValidEvent

protected readonly event: ValidEvent

Inherited from:BaseHandler

logger

protected readonly logger: Logger

protected readonly logger: Logger

Inherited from:BaseHandler

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>

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()execute() from running.

abstract async execute(): Promise<void>

abstract async execute(): Promise<void>

Inherited from:BaseHandler

match()

Run the arm for whichever command fired. Use this only when the handler is registered for several routes. A single-route handler reads this.optionsthis.options directly instead, match buys nothing there.

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>

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', true).id),
            kick: (options) => this.event.guild?.members.kick(options.getUser('member', true).id)
        });
    }
}

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

Classseedcordv0.15.0

SlashHandler

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

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'> {
    async execute() {
        const target = this.options.getUser('target'); // User
        const reason = this.options.getString('reason'); // string | null
    }
}

\@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 InteractionHandlerInteractionHandler class

InteractionHandler(event: Repliable, core: Core)

InteractionHandler(event: Repliable, core: Core)

Inherited from:InteractionHandler

Showing members with Protected visibility and higher.

Properties

core
event
logger
options

Methods

execute()
match()

Route

One or more route keys from SlashOptionRegistrySlashOptionRegistry, 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'

core

readonly core: Core

readonly core: Core

Inherited from:BaseHandler

event

protected readonly event: ValidEvent

protected readonly event: ValidEvent

Inherited from:BaseHandler

logger

protected readonly logger: Logger

protected readonly logger: Logger

Inherited from:BaseHandler

options

protected options: SlashOptions<Route, Cache>

protected options: SlashOptions<Route, Cache>

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()execute() from running.

abstract async execute(): Promise<void>

abstract async execute(): Promise<void>

Inherited from:BaseHandler

match()

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.

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

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