docs(InteractionCollector): Document channel option type (#7551)

This commit is contained in:
Jiralite
2022-03-09 15:18:18 +00:00
committed by GitHub
parent b162f27e46
commit e787cd5fa5
2 changed files with 8 additions and 1 deletions

View File

@@ -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

View File

@@ -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}