From eed293f893da2ea00cc81c49b636b98066513c4b Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Fri, 17 Feb 2023 22:02:38 +0000 Subject: [PATCH] fix: minor forums cleanup (#9033) * docs(GuildChannelResolvable): remove extra `ForumChannel` * docs: replace `GuildForumThreadChannel` * docs: `Channel` correct reference * refactor: move `threadName` to the right method --- src/managers/GuildChannelManager.js | 3 +-- src/structures/ThreadChannel.js | 2 +- src/structures/Webhook.js | 2 +- src/util/ChannelFlags.js | 2 +- typings/index.d.ts | 2 +- 5 files changed, 5 insertions(+), 6 deletions(-) diff --git a/src/managers/GuildChannelManager.js b/src/managers/GuildChannelManager.js index 4deae2c28..85db8178f 100644 --- 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 index 0565d0612..7c4ac27f8 100644 --- 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} + * @returns {Promise} */ setAppliedTags(appliedTags, reason) { return this.edit({ appliedTags }, reason); diff --git a/src/structures/Webhook.js b/src/structures/Webhook.js index efb70ced4..0efb077fa 100644 --- 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. * For interaction webhooks, this property is ignored + * @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 * For interaction webhooks, this property is ignored - * @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 index 302baa98b..2e5d8096a 100644 --- 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 index c5583f0ed..929c0c464 100644 --- 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