starboard

Efficient yet Simplest starboard system ever existed !

Program

Javascript

const simplydjs = require("simply-djs");

Typescript

import simplydjs from "simply-djs";

simplydjs.starboard(client, reaction, {
  // options (Optional)
})

INFO

Usage:

This function should be used only in messageReactionAdd, messageReactionDelete and messageDelete events

tip

When using the function for messageDelete event, replace reaction to message

• Example:

  client.on('messageDelete', () => {
    simplydjs.starboard(client, message, {
      // options (Optional)
    })
  })
  

Output

Arguments:

simplydjs.starboard(
  client: Discord.Client,
  reaction: Discord.Message | Discord.MessageReaction,
  options: starboardOption
)

• client: Discord.Client
• reaction: Discord.Message | Discord.MessageReaction
• options: starboardOption

Options starboardOption

Parameter	Type	Required	Default	Description
channelId	Channel ID	✅	none	Channel ID of a Discord TextChannel
embed	StarboardEmbed	❌	default embed	Pass a StarboardEmbed Object to customize the embed
emoji	string	❌	⭐	Emoji required as reaction to list the message on the starboard
min	string/number	❌	2	The number of reactions required to list in the starboard

StarboardEmbed options

StarboardEmbed

Parameter	Type	Description
author	MessageEmbedAuthor	Author of the embed passed as an object
title	string	Title of the embed in a function
color	ColorResolvable	Color of the embed passed as a Hex Code (or) RGB Value
description	string	Description of the embed that you're trying to edit.