From e787cd5fa5d013319347392ee4f799a677f6f512 Mon Sep 17 00:00:00 2001 From: Jiralite <33201955+Jiralite@users.noreply.github.com> Date: Wed, 9 Mar 2022 15:18:18 +0000 Subject: [PATCH] docs(InteractionCollector): Document channel option type (#7551) --- packages/discord.js/src/structures/InteractionCollector.js | 2 +- packages/discord.js/src/util/Constants.js | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/packages/discord.js/src/structures/InteractionCollector.js b/packages/discord.js/src/structures/InteractionCollector.js index 56821f39f..2b61b6347 100644 --- a/packages/discord.js/src/structures/InteractionCollector.js +++ b/packages/discord.js/src/structures/InteractionCollector.js @@ -6,7 +6,7 @@ const Events = require('../util/Events'); /** * @typedef {CollectorOptions} InteractionCollectorOptions - * @property {TextBasedChannelResolvable} [channel] The channel to listen to interactions from + * @property {TextBasedChannelsResolvable} [channel] The channel to listen to interactions from * @property {ComponentType} [componentType] The type of component to listen for * @property {GuildResolvable} [guild] The guild to listen to interactions from * @property {InteractionType} [interactionType] The type of interaction to listen for diff --git a/packages/discord.js/src/util/Constants.js b/packages/discord.js/src/util/Constants.js index d0b945683..ce72d69de 100644 --- a/packages/discord.js/src/util/Constants.js +++ b/packages/discord.js/src/util/Constants.js @@ -65,6 +65,13 @@ exports.NonSystemMessageTypes = [ * @typedef {DMChannel|TextChannel|NewsChannel|ThreadChannel} TextBasedChannels */ +/** + * Data that resolves to give a text-based channel. This can be: + * * A text-based channel + * * A snowflake + * @typedef {TextBasedChannels|Snowflake} TextBasedChannelsResolvable + */ + /** * The types of channels that are text-based. The available types are: * * {@link ChannelType.DM}