@averagehelper/corde/lib/src/api/interfaces/messageMatches.d.ts

A simple library for Discord bot tests. (Republished fork to demonstrate a bugfix)

import { MessageEmbed } from "discord.js";
import { MessageData } from "../../types";
/**
 * Defines all functions that can be used
 * to check a bot reaction of a command.
 *
 */
export interface MessageMatches {
    /**
     * Defines the message expected to be returned by a
     * command.
     *
     * @param expect A message returned by a bot after invoke a command
     * @since 1.0
     */
    toReturn(expect: string | number | boolean | MessageEmbed): void;
    /**
     * Defines reactions that must be add to command message.
     *
     * @param reaction Single or list of reactions that must be added to an message
     *
     * @see For how to react message -> https://discordjs.guide/popular-topics/reactions.html#reacting-to-messages
     *
     * @example
     *
     *  bot.on('message', async (message) => {
     *    if (command === 'emoji') {
     *       msg.react('😄');
     *    } else if(command === 'emojis') {
     *       Promise.all([msg.react('😄'), msg.react('🍊')]);
     *    }
     *  });
     *
     *  Tests:
     *
     *  expect('emoji').toAddReaction('😄');
     *  expect('emojis').toAddReaction('😄', '🍊');
     *
     * @since 1.0
     */
    toAddReaction(...reaction: string[]): void;
    /**
     * Remove a list of reactions from a message.
     *
     * @param reactions Witch reactions will be removed.
     * @param message Values that will be used to find the message. **do not use all filters**, just one.
     * message ID is the main object used to filter, so, if all filters are filled, only ID will be considered.
     * @since 2.0
     */
    toRemoveReaction(reactions: string[]): void;
    toRemoveReaction(...reactions: string[]): void;
    toRemoveReaction(reactions: string, message: MessageData): void;
    toRemoveReaction(reactions: string[], message: MessageData): void;
    /**
     * Verify if a command pinned a message.
     *
     * @param message Data used for message fetch.
     * @since 2.0
     */
    toPin(messageId: string): void;
    toPin(message: MessageData): void;
    /**
     * Verify if a command unpinned a message.
     *
     * @param message Data used for message fetch.
     * @since 2.0
     */
    toUnPin(messageId: string): void;
    toUnPin(message: MessageData): void;
    /**
     * Verify if a command edited a message.
     *
     * @param message Message to be edited.
     * @param newValue New value for the message.
     * @since 1.0
     */
    toEditMessage(message: MessageData, newValue: string | MessageEmbed): void;
}