fix(Message): update typings and docs related to #edit (#5745)

Co-authored-by: Jan <[email protected]>
discordjs · Jun 3, 2021 · a2f0c11 · a2f0c11
1 parent ff4d6dd
commit a2f0c11
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/src/structures/Message.js b/src/structures/Message.js
@@ -474,7 +474,7 @@ class Message extends Base {
   /**
    * Options that can be passed into {@link Message#edit}.
    * @typedef {Object} MessageEditOptions
-   * @property {string} [content] Content to be edited
+   * @property {?string} [content] Content to be edited
    * @property {MessageEmbed|Object} [embed] An embed to be added/edited
    * @property {string|boolean} [code] Language for optional codeblock formatting to apply
    * @property {MessageMentionOptions} [allowedMentions] Which mentions should be parsed from the message content
@@ -486,8 +486,8 @@ class Message extends Base {
 
   /**
    * Edits the content of the message.
-   * @param {string|APIMessage} [content] The new content for the message
-   * @param {MessageEditOptions|MessageEmbed} [options] The options to provide
+   * @param {?string|APIMessage} [content] The new content for the message
+   * @param {MessageEditOptions|MessageEmbed|MessageAttachment|MessageAttachment[]} [options] The options to provide
    * @returns {Promise<Message>}
    * @example
    * // Update the content of a message

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -1186,8 +1186,13 @@ declare module 'discord.js' {
       options?: ReactionCollectorOptions,
     ): ReactionCollector;
     public delete(): Promise<Message>;
-    public edit(content: string | null | MessageEditOptions | MessageEmbed | APIMessage): Promise<Message>;
-    public edit(content: string | null, options: MessageEditOptions | MessageEmbed): Promise<Message>;
+    public edit(
+      content: string | null | MessageEditOptions | MessageEmbed | APIMessage | MessageAttachment | MessageAttachment[],
+    ): Promise<Message>;
+    public edit(
+      content: string | null,
+      options: MessageEditOptions | MessageEmbed | MessageAttachment | MessageAttachment[],
+    ): Promise<Message>;
     public equals(message: Message, rawData: unknown): boolean;
     public fetchReference(): Promise<Message>;
     public fetchWebhook(): Promise<Webhook>;
@@ -3208,7 +3213,7 @@ declare module 'discord.js' {
 
   interface MessageEditOptions {
     attachments?: MessageAttachment[];
-    content?: string;
+    content?: string | null;
     embed?: MessageEmbed | MessageEmbedOptions | null;
     code?: string | boolean;
     files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];