Skip to content

Commit

Permalink
types(InteractionCollector): Fix guild and channel types (#7624)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jiralite committed Mar 10, 2022
1 parent a7535a2 commit 7814074
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
4 changes: 2 additions & 2 deletions src/structures/InteractionCollector.js
Expand Up @@ -7,9 +7,9 @@ const { InteractionTypes, MessageComponentTypes } = require('../util/Constants')

/**
* @typedef {CollectorOptions} InteractionCollectorOptions
* @property {TextBasedChannels} [channel] The channel to listen to interactions from
* @property {TextBasedChannelsResolvable} [channel] The channel to listen to interactions from
* @property {MessageComponentType} [componentType] The type of component to listen for
* @property {Guild} [guild] The guild to listen to interactions from
* @property {GuildResolvable} [guild] The guild to listen to interactions from
* @property {InteractionType} [interactionType] The type of interaction to listen for
* @property {number} [max] The maximum total amount of interactions to collect
* @property {number} [maxComponents] The maximum number of components to collect
Expand Down
7 changes: 7 additions & 0 deletions src/util/Constants.js
Expand Up @@ -558,6 +558,13 @@ exports.ChannelTypes = createEnum([
* @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:
* * DM
Expand Down
6 changes: 4 additions & 2 deletions typings/index.d.ts
Expand Up @@ -4896,9 +4896,9 @@ export type IntegrationType = 'twitch' | 'youtube' | 'discord';

export interface InteractionCollectorOptions<T extends Interaction, Cached extends CacheType = CacheType>
extends CollectorOptions<[T]> {
channel?: TextBasedChannel;
channel?: TextBasedChannelResolvable;
componentType?: MessageComponentType | MessageComponentTypes;
guild?: Guild;
guild?: GuildResolvable;
interactionType?: InteractionType | InteractionTypes;
max?: number;
maxComponents?: number;
Expand Down Expand Up @@ -5624,6 +5624,8 @@ export type GuildTextBasedChannel = Extract<GuildBasedChannel, TextBasedChannel>

export type TextChannelResolvable = Snowflake | TextChannel;

export type TextBasedChannelResolvable = Snowflake | TextBasedChannel;

export type ThreadAutoArchiveDuration = 60 | 1440 | 4320 | 10080 | 'MAX';

export type ThreadChannelResolvable = ThreadChannel | Snowflake;
Expand Down

1 comment on commit 7814074

@Srezyshka
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😀

Please sign in to comment.