djs-systems
Version:
The simplest way to build complex Discord bots.
23 lines (22 loc) • 888 B
TypeScript
import { MessageReaction } from 'discord.js';
import { ExtendedMessage, CustomizableEmbed } from './typedef';
/**
* **Documentation Url** of the type: https://simplyd.js.org/docs/systems/starboard#starboardoptions
*/
export declare type starboardOptions = {
embed?: CustomizableEmbed;
channelId?: string;
min?: number;
emoji?: string;
strict?: boolean;
};
/**
* Efficient yet Simplest starboard system ever existed !
*
* `NOTE:` **Only Use it in `messageReactionAdd`, `messageReactionRemove` and `messageDelete` events.**
* @param reaction
* @param options
* @link `Documentation:` https://simplyd.js.org/docs/systems/starboard
* @example simplydjs.starboard(reaction, { channelId: '1234567890123' })
*/
export declare function starboard(reactionOrMessage: MessageReaction | ExtendedMessage, options?: starboardOptions): Promise<void>;