Class InteractionRouter

A router that registers and organizes middleware for all supported Discord interactions.

Example

// utility/ping.js

import { InteractionRouter } from 'discord.https/router';
const router = new InteractionRouter();
export deafult router.command(
  (builder) => builder.setName("Ping!").setDescription("Returns Pong!"),
handlePong
);

Index

Constructors

constructor

Methods

autocomplete button channelSelect command mentionableSelect messageContextMenu middleware modal roleSelect stringSelect userContextMenu userSelect

Constructors

constructor

new InteractionRouter(): InteractionRouter
Returns InteractionRouter

Methods

autocomplete

autocomplete(
key: AutoCompleteKeyBuilder,
...fns: AutoCompleteMiddleware[],
): void

Registers an autocomplete interaction with its associated middleware.

Parameters

key: AutoCompleteKeyBuilder
...fns: AutoCompleteMiddleware[]
Async functions. See GenericMiddleware for callback parameters.

Returns void

Example

const githubQuery = router.command(
  (builder) =>
    builder
      .setName("weather")
      .setDescription("Query weather information!")
      .addStringOption(option =>
        option
          .setName("city")
          .setDescription("City to get the weather for")
          .setAutocomplete(true)
      ),
  handler
);
router.autocomplete(githubQuery.getAutoCompleteKey("city"), autocompleteMiddleware);

button

button(customId: string, ...fns: ButtonMiddleware[]): void
Registers a button interaction with its associated middleware.
Parameters
- customId: string
- ...fns: ButtonMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
Example
```
router.button("custom_button_id", buttonMiddleware);
```
- Defined in src/interactionRouter/index.ts:144

channelSelect

channelSelect(name: string, ...fns: SelectMenuMiddleware[]): void
Registers a channel select interaction with its associated middleware.
Parameters
- name: string
- ...fns: SelectMenuMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
Example
```
router.channelSelect("channelSelectName", channelSelectMiddleware);
```
- Defined in src/interactionRouter/index.ts:213

command

command(
commandbuilder: CommandbuilderType,
...fns: CommandMiddleware[],
): AutoCompleteKeyBuilder
Registers a command with its associated middleware.
Parameters
- commandbuilder: CommandbuilderType
  Function returning a SlashCommandBuilder.
- ...fns: CommandMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns AutoCompleteKeyBuilder
An AutoCompleteKeyBuilder for autocomplete options.
Example
```
router.command(
  (builder) => builder.setName("Ping!").setDescription("Returns Pong!"),
  async (interaction) => interaction.reply({ content: "pong!" })
);
```
- Defined in src/interactionRouter/index.ts:123

mentionableSelect

mentionableSelect(name: string, ...fns: SelectMenuMiddleware[]): void
Registers a mentionable select interaction with its associated middleware.
Parameters
- name: string
- ...fns: SelectMenuMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
Example
```
router.mentionableSelect("mentionableSelectName", mentionableSelectMiddleware);
```
- Defined in src/interactionRouter/index.ts:227

messageContextMenu

messageContextMenu(
commandbuilder: messageContextCommandBuilderType,
...fns: MessageContextMenuMiddleware[],
): void
Registers a message context menu interaction with its associated middleware.
Parameters
- commandbuilder: messageContextCommandBuilderType
- ...fns: MessageContextMenuMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
Example
```
router.messageContextMenu(builder => builder.setName("Hello"), messageContextMenuMiddleware);
```
- Defined in src/interactionRouter/index.ts:297

middleware

middleware(...fns: GeneralMiddleware[]): void
Registers local middleware that runs for every interaction handled by this router instance only.

This does not affect other routers or collectors.
Parameters
- ...fns: GeneralMiddleware[]
  Async middleware functions. See GenericMiddleware for callback parameters
Returns void
- Defined in src/interactionRouter/index.ts:103

modal(customId: string, ...fns: ModalMiddleware[]): void
Registers a modal interaction with its associated middleware.
Parameters
- customId: string
- ...fns: ModalMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
Example
```
router.modal("custom_modal_id", modalMiddleware);
```
- Defined in src/interactionRouter/index.ts:158

roleSelect

roleSelect(name: string, ...fns: SelectMenuMiddleware[]): void
Registers a role select interaction with its associated middleware.
Parameters
- name: string
- ...fns: SelectMenuMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
Example
```
router.roleSelect("roleSelectName", roleSelectMiddleware);
```
- Defined in src/interactionRouter/index.ts:172

stringSelect

stringSelect(name: string, ...fns: SelectMenuMiddleware[]): void
Registers a string select interaction with its associated middleware.
Parameters
- name: string
- ...fns: SelectMenuMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
Example
```
router.stringSelect("stringSelectName", stringSelectMiddleware);
```
- Defined in src/interactionRouter/index.ts:199

userContextMenu

userContextMenu(
commandbuilder: userContextCommandBuilderType,
...fns: UserContextMenuMiddleware[],
): void
Registers a user context menu interaction with its associated middleware.
Parameters
- commandbuilder: userContextCommandBuilderType
- ...fns: UserContextMenuMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
Example
```
router.userContextMenu(builder => builder.setName("Hello"), userContextMenuMiddleware);
```
- Defined in src/interactionRouter/index.ts:275

userSelect

userSelect(name: string, ...fns: SelectMenuMiddleware[]): void
Registers a user select interaction with its associated middleware.
Parameters
- name: string
- ...fns: SelectMenuMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
Example
```
router.userSelect("userSelectName", userSelectMiddleware);
```
- Defined in src/interactionRouter/index.ts:186

Class InteractionRouter

Example

Index

Constructors

Methods

Constructors

constructor

Returns InteractionRouter

Methods

autocomplete

Parameters

Returns void

Example

button

Parameters

Returns void

Example

channelSelect

Parameters

Returns void

Example

command

Parameters

Returns AutoCompleteKeyBuilder

Example

mentionableSelect

Parameters

Returns void

Example

messageContextMenu

Parameters

Returns void

Example

middleware

Parameters

Returns void

modal

Parameters

Returns void

Example

roleSelect

Parameters

Returns void

Example

stringSelect

Parameters

Returns void

Example

userContextMenu

Parameters

Returns void

Example

userSelect

Parameters

Returns void

Example

Settings

On This Page