fix: minor forums cleanup (#9033)

* docs(GuildChannelResolvable): remove extra `ForumChannel` * docs: replace `GuildForumThreadChannel` * docs: `Channel` correct reference * refactor: move `threadName` to the right method
discordjs · Feb 17, 2023 · eed293f · eed293f
1 parent 86329ad
commit eed293f
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 6 deletions.
diff --git a/src/managers/GuildChannelManager.js b/src/managers/GuildChannelManager.js
@@ -80,9 +80,8 @@ class GuildChannelManager extends CachedManager {
    * Data that can be resolved to give a Guild Channel object. This can be:
    * * A GuildChannel object
    * * A ThreadChannel object
-   * * A ForumChannel object
    * * A Snowflake
-   * @typedef {GuildChannel|ThreadChannel|ForumChannel|Snowflake} GuildChannelResolvable
+   * @typedef {GuildChannel|ThreadChannel|Snowflake} GuildChannelResolvable
    */
 
   /**

diff --git a/src/structures/ThreadChannel.js b/src/structures/ThreadChannel.js
@@ -468,7 +468,7 @@ class ThreadChannel extends Channel {
    * Set the applied tags for this channel (only applicable to forum threads)
    * @param {Snowflake[]} appliedTags The tags to set for this channel
    * @param {string} [reason] Reason for changing the thread's applied tags
-   * @returns {Promise<GuildForumThreadChannel>}
+   * @returns {Promise<ThreadChannel>}
    */
   setAppliedTags(appliedTags, reason) {
     return this.edit({ appliedTags }, reason);

diff --git a/src/structures/Webhook.js b/src/structures/Webhook.js
@@ -116,6 +116,7 @@ class Webhook {
    * @property {string} [avatarURL] Avatar URL override for the message
    * @property {Snowflake} [threadId] The id of the thread in the channel to send to.
    * <info>For interaction webhooks, this property is ignored</info>
+   * @property {string} [threadName] Name of the thread to create (only available if webhook is in a forum channel)
    * @property {MessageFlags} [flags] Which flags to set for the message. Only `SUPPRESS_EMBEDS` can be set.
    */
 
@@ -131,7 +132,6 @@ class Webhook {
    * Action rows containing interactive components for the message (buttons, select menus)
    * @property {Snowflake} [threadId] The id of the thread this message belongs to
    * <info>For interaction webhooks, this property is ignored</info>
-   * @property {string} [threadName] Name of the thread to create (only available if webhook is in a forum channel)
    */
 
   /**

diff --git a/src/util/ChannelFlags.js b/src/util/ChannelFlags.js
@@ -3,7 +3,7 @@
 const BitField = require('./BitField');
 
 /**
- * Data structure that makes it easy to interact with a {@link BaseChannel#flags} bitfield.
+ * Data structure that makes it easy to interact with a {@link Channel#flags} bitfield.
  * @extends {BitField}
  */
 class ChannelFlags extends BitField {}

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -6353,7 +6353,6 @@ export interface ThreadEditData {
   rateLimitPerUser?: number;
   locked?: boolean;
   invitable?: boolean;
-  threadName?: string;
   appliedTags?: Snowflake[];
   flags?: ChannelFlagsResolvable;
 }
@@ -6434,6 +6433,7 @@ export interface WebhookMessageOptions extends Omit<MessageOptions, 'reply' | 's
   username?: string;
   avatarURL?: string;
   threadId?: Snowflake;
+  threadName?: string;
 }
 
 export type WebhookType = keyof typeof WebhookTypes;