Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-17 20:13:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor(awaitMessageComponentInteraction): use options object for lib consistency (#5852)

Browse Source
This commit is contained in:
monbrey
2021-06-15 21:02:48 +10:00
committed by GitHub
parent 96a4e7b86e
commit 9dda9b742f
4 changed files with 26 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/errors/Messages.js
View File

@@ -50,7 +50,7 @@ const Messages = {
BUTTON_URL: 'MessageButton url must be a string', BUTTON_URL: 'MessageButton url must be a string',
BUTTON_CUSTOM_ID: 'MessageButton customID must be a string', BUTTON_CUSTOM_ID: 'MessageButton customID must be a string',
INTERACTION_COLLECTOR_TIMEOUT: 'Collector timed out without receiving any interactions', INTERACTION_COLLECTOR_ERROR: reason => `Collector received no interactions before ending with reason: ${reason}`,
FILE_NOT_FOUND: file => `File could not be found: ${file}`, FILE_NOT_FOUND: file => `File could not be found: ${file}`,

18
src/structures/Message.js
View File

@@ -439,26 +439,32 @@ class Message extends Base {
return new MessageComponentInteractionCollector(this, filter, options); return new MessageComponentInteractionCollector(this, filter, options);
} }
/**
* An object containing the same properties as CollectorOptions, but a few more:
* @typedef {Object} AwaitMessageComponentInteractionOptions
* @property {number} [time] Time to wait for an interaction before rejecting
*/
/** /**
* Collects a single component interaction that passes the filter. * Collects a single component interaction that passes the filter.
* The Promise will reject if the time expires. * The Promise will reject if the time expires.
* @param {CollectorFilter} filter The filter function to use * @param {CollectorFilter} filter The filter function to use
* @param {number} [time] Time to wait for an interaction before rejecting * @param {AwaitMessageComponentInteractionOptions} [options={}] Options to pass to the internal collector
* @returns {Promise<MessageComponentInteraction>} * @returns {Promise<MessageComponentInteraction>}
* @example * @example
* // Collect a message component interaction * // Collect a message component interaction
* const filter = (interaction) => interaction.customID === 'button' && interaction.user.id === 'someID'; * const filter = (interaction) => interaction.customID === 'button' && interaction.user.id === 'someID';
* message.awaitMessageComponentInteraction(filter, 15000) * message.awaitMessageComponentInteraction(filter, { time: 15000 })
* .then(interaction => console.log(`${interaction.customID} was clicked!`)) * .then(interaction => console.log(`${interaction.customID} was clicked!`))
* .catch(console.error); * .catch(console.error);
*/ */
awaitMessageComponentInteraction(filter, time) { awaitMessageComponentInteraction(filter, { time } = {}) {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const collector = this.createMessageComponentInteractionCollector(filter, { max: 1, time }); const collector = this.createMessageComponentInteractionCollector(filter, { max: 1, time });
collector.once('end', interactions => { collector.once('end', (interactions, reason) => {
const interaction = interactions.first(); const interaction = interactions.first();
if (!interaction) reject(new Error('INTERACTION_COLLECTOR_TIMEOUT')); if (interaction) resolve(interaction);
else resolve(interaction); else reject(new Error('INTERACTION_COLLECTOR_ERROR', reason));
}); });
}); });
} }

14
src/structures/interfaces/TextBasedChannel.js
View File

@@ -342,22 +342,22 @@ class TextBasedChannel {
* Collects a single component interaction that passes the filter. * Collects a single component interaction that passes the filter.
* The Promise will reject if the time expires. * The Promise will reject if the time expires.
* @param {CollectorFilter} filter The filter function to use * @param {CollectorFilter} filter The filter function to use
* @param {number} [time] Time to wait for an interaction before rejecting * @param {AwaitMessageComponentInteractionOptions} [options={}] Options to pass to the internal collector
* @returns {Promise<MessageComponentInteraction>} * @returns {Promise<MessageComponentInteraction>}
* @example * @example
* // Collect a button interaction * // Collect a message component interaction
* const filter = (interaction) => interaction.customID === 'button' && interaction.user.id === 'someID'; * const filter = (interaction) => interaction.customID === 'button' && interaction.user.id === 'someID';
* channel.awaitMessageComponentInteraction(filter, 15000) * channel.awaitMessageComponentInteraction(filter, { time: 15000 })
* .then(interaction => console.log(`${interaction.customID} was clicked!`)) * .then(interaction => console.log(`${interaction.customID} was clicked!`))
* .catch(console.error); * .catch(console.error);
*/ */
awaitMessageComponentInteraction(filter, time) { awaitMessageComponentInteraction(filter, { time } = {}) {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const collector = this.createMessageComponentInteractionCollector(filter, { max: 1, time }); const collector = this.createMessageComponentInteractionCollector(filter, { max: 1, time });
collector.once('end', interactions => { collector.once('end', (interactions, reason) => {
const interaction = interactions.first(); const interaction = interactions.first();
if (!interaction) reject(new Error('INTERACTION_COLLECTOR_TIMEOUT')); if (interaction) resolve(interaction);
else resolve(interaction); else reject(new Error('INTERACTION_COLLECTOR_ERROR', reason));
}); });
}); });
} }

8
typings/index.d.ts vendored
View File

@@ -1189,7 +1189,7 @@ declare module 'discord.js' {
public reference: MessageReference | null; public reference: MessageReference | null;
public awaitMessageComponentInteraction( public awaitMessageComponentInteraction(
filter: CollectorFilter<[MessageComponentInteraction]>, filter: CollectorFilter<[MessageComponentInteraction]>,
time?: number, options?: AwaitMessageComponentInteractionOptions,
): Promise<MessageComponentInteraction>; ): Promise<MessageComponentInteraction>;
public awaitReactions( public awaitReactions(
filter: CollectorFilter<[MessageReaction, User]>, filter: CollectorFilter<[MessageReaction, User]>,
@@ -2373,7 +2373,7 @@ declare module 'discord.js' {
typingCount: number; typingCount: number;
awaitMessageComponentInteraction( awaitMessageComponentInteraction(
filter: CollectorFilter<[MessageComponentInteraction]>, filter: CollectorFilter<[MessageComponentInteraction]>,
time?: number, options?: AwaitMessageComponentInteractionOptions,
): Promise<MessageComponentInteraction>; ): Promise<MessageComponentInteraction>;
awaitMessages( awaitMessages(
filter: CollectorFilter<[Message]>, filter: CollectorFilter<[Message]>,
@@ -2581,6 +2581,10 @@ declare module 'discord.js' {
new?: any; new?: any;
} }
interface AwaitMessageComponentInteractionOptions {
time?: number;
}
interface AwaitMessagesOptions extends MessageCollectorOptions { interface AwaitMessagesOptions extends MessageCollectorOptions {
errors?: string[]; errors?: string[];
} }