docs: create ThreadAutoArchiveDuration typedef

discordjs · May 12, 2021 · 6c85368 · 6c85368
1 parent d570121
commit 6c85368
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 9 deletions.
diff --git a/src/managers/ThreadManager.js b/src/managers/ThreadManager.js
@@ -58,6 +58,15 @@ class ThreadManager extends BaseManager {
    * @returns {?Snowflake}
    */
 
+  /**
+   * A number that is allowed to be the duration in minutes before a thread is automatically archived. This can be:
+   * * `60` (1 hour)
+   * * `1440` (1 day)
+   * * `4320` (3 days)
+   * * `10080` (7 days)
+   * @typedef {number} ThreadAutoArchiveDuration
+   */
+
   /**
    * Creates a new thread in the channel.
    * @param {string} name The name of the new Thread

diff --git a/src/structures/Message.js b/src/structures/Message.js
@@ -629,7 +629,7 @@ class Message extends Base {
    * Create a new public thread from this message
    * @see ThreadManager#create
    * @param {string} name The name ofthe new Thread
-   * @param {number} autoArchiveDuration How long in minutes before the thread is automatically archived
+   * @param {ThreadAutoArchiveDuration} autoArchiveDuration How long before the thread is automatically archived
    * @param {string} [reason] Reason for creating the thread
    * @returns {Promise<ThreadChannel>}
    */

diff --git a/src/structures/ThreadChannel.js b/src/structures/ThreadChannel.js
@@ -256,8 +256,7 @@ class ThreadChannel extends Channel {
 
   /**
    * Sets the duration before the channel is automatically archived.
-   * @param {number} autoArchiveDuration How long in minutes before the thread is automatically archived,
-   * one of `60`, `1440`, `4320`, or `10080`
+   * @param {ThreadAutoArchiveDuration} autoArchiveDuration How long before the thread is automatically archived
    * @param {string} [reason] Reason for changing the archive time
    * @returns {Promise<ThreadChannel>}
    * @example

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -1192,7 +1192,7 @@ declare module 'discord.js' {
     public reply(content: StringResolvable, options: ReplyMessageOptions): Promise<Message | Message[]>;
     public startThread(
       name: 'string',
-      autoArchiveDuration: AutoArchiveDuration,
+      autoArchiveDuration: ThreadAutoArchiveDuration,
       reason?: string,
     ): Promise<ThreadChannel>;
     public suppressEmbeds(suppress?: boolean): Promise<Message>;
@@ -1710,7 +1710,7 @@ declare module 'discord.js' {
     public readonly archivedAt: Date;
     public archiverID: Snowflake | null;
     public archiveTimestamp: number | null;
-    public autoArchiveDuration: AutoArchiveDuration;
+    public autoArchiveDuration: ThreadAutoArchiveDuration;
     public readonly deletable: boolean;
     public readonly editable: boolean;
     public guild: Guild;
@@ -1737,7 +1737,10 @@ declare module 'discord.js' {
     public permissionsFor(memberOrRole: GuildMember | Role): Readonly<Permissions>;
     public permissionsFor(memberOrRole: GuildMemberResolvable | RoleResolvable): Readonly<Permissions> | null;
     public setArchived(archived: boolean, reason?: string): Promise<ThreadChannel>;
-    public setAutoArchiveDuration(autoArchiveDuration: AutoArchiveDuration, reason?: string): Promise<ThreadChannel>;
+    public setAutoArchiveDuration(
+      autoArchiveDuration: ThreadAutoArchiveDuration,
+      reason?: string,
+    ): Promise<ThreadChannel>;
     public setLocked(locked: boolean, reason?: string): Promise<ThreadChannel>;
     public setName(name: string, reason?: string): Promise<ThreadChannel>;
     public setRateLimitPerUser(rateLimitPerUser: number, reason?: string): Promise<ThreadChannel>;
@@ -2336,7 +2339,7 @@ declare module 'discord.js' {
     public channel: TextChannel | NewsChannel;
     public create(
       name: string,
-      autoArchiveDuration: AutoArchiveDuration,
+      autoArchiveDuration: ThreadAutoArchiveDuration,
       options?: { startMessage?: MessageResolvable; reason?: string },
     ): Promise<ThreadChannel>;
     public fetch(options: ThreadChannelResolvable, cache?: boolean, force?: boolean): Promise<ThreadChannel | null>;
@@ -2618,7 +2621,7 @@ declare module 'discord.js' {
     new?: any;
   }
 
-  type AutoArchiveDuration = 60 | 1440 | 4320 | 10080;
+  type ThreadAutoArchiveDuration = 60 | 1440 | 4320 | 10080;
 
   interface AwaitMessagesOptions extends MessageCollectorOptions {
     errors?: string[];
@@ -3765,7 +3768,7 @@ declare module 'discord.js' {
   interface ThreadEditData {
     name?: string;
     archived?: boolean;
-    autoArchiveDuration?: AutoArchiveDuration;
+    autoArchiveDuration?: ThreadAutoArchiveDuration;
     rateLimitPeruser?: number;
     locked?: boolean;
   }