djs-systems/typings/src/bumpReminder.d.ts

The simplest way to build complex Discord bots.

import { Client, Message } from 'discord.js';
import { CustomizableEmbed } from './typedef';
/**
 * **Documentation Url** of the type: https://simplyd.js.org/docs/systems/bumpReminder#bumpreminderembeds
 */
export interface BumpReminderEmbeds {
    thank?: CustomizableEmbed;
    remind?: CustomizableEmbed;
}
/**
 * **Documentation Url** of the options: https://simplyd.js.org/docs/systems/bumpReminder#bumpoptions
 */
export declare type bumpOptions = {
    strict: boolean;
    content?: string;
    embed?: BumpReminderEmbeds;
    toggle?: boolean;
    channelId?: string[];
};
/**
 * A Very cool bump reminder system that reminds when a bump is necessary [Only Disboard].
 *
 * **Requires you to have this in `messageCreate` and `ready` event**
 * @param client
 * @param message
 * @param options
 * @link `Documentation:` https://simplyd.js.org/docs/systems/bumpReminder
 * @example simplydjs.bumpReminder(client, message)
 */
export declare function bumpReminder(client: Client, message: Message | bumpOptions, options: bumpOptions): Promise<boolean>;