refactor(Message): accept a single object instead of 3 arguments (#6244)

Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>
discordjs · Jul 31, 2021 · 434e330 · 434e330
1 parent 198a5c4
commit 434e330
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 19 deletions.
diff --git a/src/managers/ThreadManager.js b/src/managers/ThreadManager.js
@@ -71,16 +71,12 @@ class ThreadManager extends CachedManager {
 
   /**
    * Options for creating a thread. <warn>Only one of `startMessage` or `type` can be defined.</warn>
-   * @typedef {Object} ThreadCreateOptions
-   * @property {string} name The name of the new thread
-   * @property {ThreadAutoArchiveDuration} autoArchiveDuration The amount of time (in minutes) after which the thread
-   * should automatically archive in case of no recent activity
+   * @typedef {StartThreadOptions} ThreadCreateOptions
    * @property {MessageResolvable} [startMessage] The message to start a thread from. <warn>If this is defined then type
    * of thread gets automatically defined and cannot be changed. The provided `type` field will be ignored</warn>
    * @property {ThreadChannelTypes|number} [type] The type of thread to create. Defaults to `GUILD_PUBLIC_THREAD` if
    * created in a {@link TextChannel} <warn>When creating threads in a {@link NewsChannel} this is ignored and is always
    * `GUILD_NEWS_THREAD`</warn>
-   * @property {string} [reason] Reason for creating the thread
    */
 
   /**

diff --git a/src/structures/Message.js b/src/structures/Message.js
@@ -727,20 +727,27 @@ class Message extends Base {
     return this.channel.send(data);
   }
 
+  /**
+   * Options for starting a thread on a message.
+   * @typedef {Object} StartThreadOptions
+   * @property {string} name The name of the new thread
+   * @property {ThreadAutoArchiveDuration} autoArchiveDuration The amount of time (in minutes) after which the thread
+   * should automatically archive in case of no recent activity
+   * @property {string} [reason] Reason for creating the thread
+   */
+
   /**
    * Create a new public thread from this message
    * @see ThreadManager#create
-   * @param {string} name The name of the new Thread
-   * @param {ThreadAutoArchiveDuration} autoArchiveDuration How long before the thread is automatically archived
-   * @param {string} [reason] Reason for creating the thread
+   * @param {StartThreadOptions} [options] Options for starting a thread on this message
    * @returns {Promise<ThreadChannel>}
    */
-  startThread(name, autoArchiveDuration, reason) {
+  startThread(options = {}) {
     if (!['GUILD_TEXT', 'GUILD_NEWS'].includes(this.channel.type)) {
       return Promise.reject(new Error('MESSAGE_THREAD_PARENT'));
     }
     if (this.hasThread) return Promise.reject(new Error('MESSAGE_EXISTING_THREAD'));
-    return this.channel.threads.create({ name, autoArchiveDuration, startMessage: this, reason });
+    return this.channel.threads.create({ ...options, startMessage: this });
   }
 
   /**

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -1031,11 +1031,7 @@ export class Message extends Base {
   public react(emoji: EmojiIdentifierResolvable): Promise<MessageReaction>;
   public removeAttachments(): Promise<Message>;
   public reply(options: string | MessagePayload | ReplyMessageOptions): Promise<Message>;
-  public startThread(
-    name: string,
-    autoArchiveDuration: ThreadAutoArchiveDuration,
-    reason?: string,
-  ): Promise<ThreadChannel>;
+  public startThread(options: StartThreadOptions): Promise<ThreadChannel>;
   public suppressEmbeds(suppress?: boolean): Promise<Message>;
   public toJSON(): unknown;
   public toString(): string;
@@ -4278,6 +4274,12 @@ export interface StaticImageURLOptions {
 
 export type StageInstanceResolvable = StageInstance | Snowflake;
 
+export interface StartThreadOptions {
+  name: string;
+  autoArchiveDuration: ThreadAutoArchiveDuration;
+  reason?: string;
+}
+
 export type Status = number;
 
 export type StickerFormatType = keyof typeof StickerFormatTypes;
@@ -4325,12 +4327,9 @@ export type ThreadChannelResolvable = ThreadChannel | Snowflake;
 
 export type ThreadChannelTypes = 'GUILD_NEWS_THREAD' | 'GUILD_PUBLIC_THREAD' | 'GUILD_PRIVATE_THREAD';
 
-export interface ThreadCreateOptions<AllowedThreadType> {
-  name: string;
-  autoArchiveDuration: ThreadAutoArchiveDuration;
+export interface ThreadCreateOptions<AllowedThreadType> extends StartThreadOptions {
   startMessage?: MessageResolvable;
   type?: AllowedThreadType;
-  reason?: string;
 }
 
 export interface ThreadEditData {