Class default

Discord HTTPS Interaction Client.

Handles registration of commands, buttons, modals, select menus, context menus, and autocomplete interactions with their associated middleware.

Also exposes a REST client for direct API calls.

Example

import Client, { InteractionResponseType } from "./Client.js";
import NodeAdapter from "@discordhttps/nodejs-adapter";

const client = new Client({
  token: process.env.BOT_TOKEN!,
  publicKey: process.env.PUBLIC_KEY!,
  httpAdapter: new NodeAdapter(),
});

client.command(
  (builder) => builder.setName("ping").setDescription("Replies with Pong!"),
  async (interaction, client, _, res) => {
    res.writeHead(200, {
      "Content-Type": "application/json",
    });
    const username = interaction.user
      ? interaction.user.global_name
      : interaction.member.user.global_name;
    res.end(
      JSON.stringify({
        type: InteractionResponseType.ChannelMessageWithSource,
        data: {
          content: `Hello! ${username}`,
        },
      })
    );
  }
);

await client.listen("interactions", 3000, () => {
  console.log(
    "Listening for interactions on port 3000 at the /interactions endpoint"
  );
});

Hierarchy

HttpInteractionServer
- default

Index

Constructors

constructor

new default(options: ClientOptions): default
Creates a new Discord HTTPS Interaction Client.
Parameters
- options: ClientOptions
  Client configuration options.
  - Optionaldebug?: boolean
  - httpAdapter: HttpAdapter
  - publicKey: string
  - token: string
Returns default
Overrides HttpInteractionServer.constructor
- Defined in src/index.ts:118

Properties

`Protected`isDebug

isDebug: boolean = false

`Readonly`rest

rest: REST

REST API client instance used for interacting with Discord's HTTP API.

See

REST Documentation

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 weather = router.command(
 async(builder) =>
    builder
      .setName("weather")
      .setDescription("Query weather information!")
      .addStringOption(option =>
        option
          .setName("city")  // Option Name
          .setDescription("City to get the weather for")
          .setAutocomplete(true) // Enable autocomplete for this option
      ),
  handler
);
router.autocomplete(weather.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", async (interaction) => await interaction.reply("Button Pressed!"));
```
- Defined in src/index.ts:218

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/index.ts:287

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) => await interaction.reply("Pong!")
);
```
- Defined in src/index.ts:197

`Protected`debug

debug(...message: string[]): void
Prints debug messages with a timestamp if debug mode is enabled.
Parameters
- ...message: string[]
  Message parts to log.
Returns void
Inherited from HttpInteractionServer.debug
- Defined in src/interactionServer.ts:161

getHandler

getHandler(
endpoint: string,
): (
...args: [req: HttpAdapterRequest, res: HttpAdapterSererResponse],
) => Promise
Returns a request handler bound to the provided endpoint.

Example for making your own adapter, see these GitHub repositories:

GitHub repositories:
- Node.js Adapter: https://github.com/discordhttps/nodejs-adapter
- Cloudflare Adapter: https://github.com/discordhttps/cloudflare-adapter
Parameters
- endpoint: string
  URL path where Discord will POST interactions (e.g. "/interactions").
Returns (...args: [req: HttpAdapterRequest, res: HttpAdapterSererResponse]) => Promise
Inherited from HttpInteractionServer.getHandler
- Defined in src/interactionServer.ts:232

getRegistar

getRegistar(
    log?: boolean,
): Promise<
    {
        payload: APIApplication;
        globalSlashRegistar(): Promise<void>;
        localSlashRegistar(guildId: string): Promise<void>;
    },
>
Returns helpers for registering slash commands.
Parameters
- log: boolean = true
  Log progress. Defaults to true.
Returns Promise<
    {
        payload: APIApplication;
        globalSlashRegistar(): Promise<void>;
        localSlashRegistar(guildId: string): Promise<void>;
    },
>
An object containing:
- globalSlashRegistrar: Function to register commands globally.
- localSlashRegistrar(guildId: string): Function to register commands locally for a specific guild, requires the guild ID as a parameter.
- payload: The payload returned from GET /applications/@me.
- Defined in src/index.ts:423

listen

listen(endpoint: string, ...args: any): Promise<any>
Starts listening for HTTP requests using the configured HttpAdapter.
Parameters
- endpoint: string
  The endpoint path (e.g. "/interactions").
- ...args: any
  Extra arguments passed to the adapter's listen method. Adapter-specific usage: - Node.js Adapter: standard Node.js server arguments, e.g., port and optional callback: ts client.listen("/interactions", 3000, () => { console.log("Server is active at /interactions"); }); - Cloudflare Adapter: expects a Request object from the Cloudflare Worker fetch event: ts return await client.listen("/interactions", request);
Returns Promise<any>
A promise resolving to the adapter's listen result.
Inherited from HttpInteractionServer.listen
- Defined in src/interactionServer.ts:260

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/index.ts:301

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/index.ts:375

middleware

middleware(...fns: GeneralMiddleware[]): void
Adds global middleware that runs on every interaction.

Receives raw APIInteraction payload and response object.
Parameters
- ...fns: GeneralMiddleware[]
  Async functions. See GenericMiddleware for callback parameters.
Returns void
- Defined in src/index.ts:147

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/index.ts:232

register

register(...routes: (InteractionRouter | InteractionRouterCollector)[]): void
Registers interaction routes.
Parameters
- ...routes: (InteractionRouter | InteractionRouterCollector)[]
  InteractionRouter or InteractionRouterCollector instances.
Returns void
- Defined in src/index.ts:134

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/index.ts:246

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/index.ts:273

unknown

unknown(...fns: UnknownMiddleware[]): void
Adds global middleware for unknown interactions.
Parameters
- ...fns: UnknownMiddleware[]
  Async Functions executed when no handler matches an interaction. See UnknownMiddleware for callback parameters.
Returns void
- Defined in src/index.ts:157

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/index.ts:353

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/index.ts:260

Class default

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optionaldebug?: boolean

httpAdapter: HttpAdapter

publicKey: string

token: string

Returns default

Properties

ProtectedisDebug

Readonlyrest

See

Methods

autocomplete

Parameters

Returns void

Example

button

Parameters

Returns void

Example

channelSelect

Parameters

Returns void

Example

command

Parameters

Returns AutoCompleteKeyBuilder

Example

Protecteddebug

Parameters

Returns void

getHandler

Parameters

Returns (...args: [req: HttpAdapterRequest, res: HttpAdapterSererResponse]) => Promise

getRegistar

Parameters

Returns Promise< { payload: APIApplication; globalSlashRegistar(): Promise<void>; localSlashRegistar(guildId: string): Promise<void>; },>

listen

Parameters

Returns Promise<any>

mentionableSelect

Parameters

Returns void

Example

messageContextMenu

Parameters

Returns void

Example

middleware

Parameters

Returns void

modal

Parameters

Returns void

Example

register

Parameters

Returns void

roleSelect

Parameters

Returns void

Example

stringSelect

Parameters

Returns void

Example

unknown

Parameters

Returns void

userContextMenu

Parameters

Returns void

`Optional`debug?: boolean

`Protected`isDebug

`Readonly`rest

`Protected`debug

Returns Promise<
{
payload: APIApplication;
globalSlashRegistar(): Promise<void>;
localSlashRegistar(guildId: string): Promise<void>;
},
>