fix: Remove DM channels from Client#messageDeleteBulk's types (#8460)

discordjs · Aug 10, 2022 · 6c6fe74 · 6c6fe74 · vercel · Aug 10, 2022
1 parent 0e2a095
commit 6c6fe74
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/packages/discord.js/src/client/actions/MessageDeleteBulk.js b/packages/discord.js/src/client/actions/MessageDeleteBulk.js
@@ -33,7 +33,7 @@ class MessageDeleteBulkAction extends Action {
        * Emitted whenever messages are deleted in bulk.
        * @event Client#messageDeleteBulk
        * @param {Collection<Snowflake, Message>} messages The deleted messages, mapped by their id
-       * @param {TextBasedChannels} channel The channel that the messages were deleted in
+       * @param {GuildTextBasedChannel} channel The channel that the messages were deleted in
        */
       if (messages.size > 0) client.emit(Events.MessageBulkDelete, messages, channel);
       return { messages };

diff --git a/packages/discord.js/src/util/Constants.js b/packages/discord.js/src/util/Constants.js
@@ -53,13 +53,19 @@ exports.NonSystemMessageTypes = [
 ];
 
 /**
- * The channels that are text-based.
- * * DMChannel
+ * The guild channels that are text-based.
  * * TextChannel
  * * NewsChannel
  * * ThreadChannel
  * * VoiceChannel
- * @typedef {DMChannel|TextChannel|NewsChannel|ThreadChannel|VoiceChannel} TextBasedChannels
+ * @typedef {TextChannel|NewsChannel|ThreadChannel|VoiceChannel} GuildTextBasedChannel
+ */
+
+/**
+ * The channels that are text-based.
+ * * DMChannel
+ * * GuildTextBasedChannel
+ * @typedef {DMChannel|GuildTextBasedChannel} TextBasedChannels
  */
 
 /**

diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts
@@ -4134,7 +4134,7 @@ export interface ClientEvents {
     reactions: Collection<string | Snowflake, MessageReaction>,
   ];
   messageReactionRemoveEmoji: [reaction: MessageReaction | PartialMessageReaction];
-  messageDeleteBulk: [messages: Collection<Snowflake, Message | PartialMessage>, channel: TextBasedChannel];
+  messageDeleteBulk: [messages: Collection<Snowflake, Message | PartialMessage>, channel: GuildTextBasedChannel];
   messageReactionAdd: [reaction: MessageReaction | PartialMessageReaction, user: User | PartialUser];
   messageReactionRemove: [reaction: MessageReaction | PartialMessageReaction, user: User | PartialUser];
   messageUpdate: [oldMessage: Message | PartialMessage, newMessage: Message | PartialMessage];