feat: InteractionDeferOptions (#5641)

src/structures/CommandInteraction.js

@@ -61,9 +61,15 @@ class CommandInteraction extends Interaction {
     return this.guild?.commands.cache.get(id) ?? this.client.application.commands.cache.get(id) ?? null;
   }
 
+  /**
+   * Options for deferring the reply to a {@link CommandInteraction}.
+   * @typedef {InteractionDeferOptions}
+   * @property {boolean} [ephemeral] Whether the reply should be ephemeral
+   */
+
   /**
    * Defers the reply to this interaction.
-   * @param {boolean} [ephemeral] Whether the reply should be ephemeral
+   * @param {InteractionDeferOptions} [options] Options for deferring the reply to this interaction
    * @returns {Promise<void>}
    * @example
    * // Defer the reply to this interaction
@@ -72,11 +78,11 @@ class CommandInteraction extends Interaction {
    *   .catch(console.error)
    * @example
    * // Defer to send an ephemeral reply later
-   * interaction.defer(true)
+   * interaction.defer({ ephemeral: true })
    *   .then(console.log)
    *   .catch(console.error);
    */
-  async defer(ephemeral) {
+  async defer({ ephemeral } = {}) {
     if (this.deferred || this.replied) throw new Error('INTERACTION_ALREADY_REPLIED');
     await this.client.api.interactions(this.id, this.token).callback.post({
       data: {

typings/index.d.ts

@@ -418,7 +418,7 @@ declare module 'discord.js' {
     public options: CommandInteractionOption[];
     public replied: boolean;
     public webhook: WebhookClient;
-    public defer(ephemeral?: boolean): Promise<void>;
+    public defer(options?: InteractionDeferOptions): Promise<void>;
     public deleteReply(): Promise<void>;
     public editReply(
       content: string | APIMessage | WebhookEditMessageOptions | MessageAdditions,
@@ -3074,6 +3074,10 @@ declare module 'discord.js' {
     name: string;
   }
 
+  interface InteractionDeferOptions {
+    ephemeral?: boolean;
+  }
+
   interface InteractionReplyOptions extends Omit<WebhookMessageOptions, 'username' | 'avatarURL'> {
     ephemeral?: boolean;
   }