fix: minor forums cleanup (#9033)

* docs(GuildChannelResolvable): remove extra `ForumChannel`

* docs: replace `GuildForumThreadChannel`

* docs: `Channel` correct reference

* refactor: move `threadName` to the right method
This commit is contained in:
Jiralite
2023-02-17 22:02:38 +00:00
committed by GitHub
parent 86329ad66f
commit eed293f893
5 changed files with 5 additions and 6 deletions

View File

@@ -80,9 +80,8 @@ class GuildChannelManager extends CachedManager {
* Data that can be resolved to give a Guild Channel object. This can be: * Data that can be resolved to give a Guild Channel object. This can be:
* * A GuildChannel object * * A GuildChannel object
* * A ThreadChannel object * * A ThreadChannel object
* * A ForumChannel object
* * A Snowflake * * A Snowflake
* @typedef {GuildChannel|ThreadChannel|ForumChannel|Snowflake} GuildChannelResolvable * @typedef {GuildChannel|ThreadChannel|Snowflake} GuildChannelResolvable
*/ */
/** /**

View File

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

View File

@@ -116,6 +116,7 @@ class Webhook {
* @property {string} [avatarURL] Avatar URL override for the message * @property {string} [avatarURL] Avatar URL override for the message
* @property {Snowflake} [threadId] The id of the thread in the channel to send to. * @property {Snowflake} [threadId] The id of the thread in the channel to send to.
* <info>For interaction webhooks, this property is ignored</info> * <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. * @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) * Action rows containing interactive components for the message (buttons, select menus)
* @property {Snowflake} [threadId] The id of the thread this message belongs to * @property {Snowflake} [threadId] The id of the thread this message belongs to
* <info>For interaction webhooks, this property is ignored</info> * <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)
*/ */
/** /**

View File

@@ -3,7 +3,7 @@
const BitField = require('./BitField'); 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} * @extends {BitField}
*/ */
class ChannelFlags extends BitField {} class ChannelFlags extends BitField {}

2
typings/index.d.ts vendored
View File

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