npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

starify-discord

v1.0.6

Published

Customizable framework to create and manage starboards with discord.js

Downloads

3

Readme

🌟 Starify Discord 🌟

starify-discord is a node.js module with a customizable framework that makes it easy to create and manage starboards!

Click here to view on NPM!

✨ Features

  • very customizable!
  • very easy to use!
  • support for multiple databases (SQLite, Postgres, MySQL, Microsoft SQL Server, MariaDB)!
  • ability to have "secret" starboards that only work in specific channels!
  • ability to restrict starboards to members with a certain role or ignore a certain role!
  • and more!

Installation

npm install starify-discord

Example Usage

Setup:

const Discord = require("discord.js");
const { StarboardsManager } = require("starify-discord");

const client = new Discord.Client({ intents: [Discord.Intents.FLAGS.GUILDS, Discord.Intents.FLAGS.GUILD_MESSAGES, Discord.Intents.FLAGS.GUILD_MESSAGE_REACTIONS] });

client.starboardManager = new StarboardsManager(client, {
    storage: {
        type: "sqlite",
        file: "./starboards.sqlite",
        name: "database",
        username: "user",
        password: "password",
        host: "localhost",
    },
    default: {
        emoji: "⭐",
        color: "#f0ec0e",
        selfStar: false,
        botStar: false,
        ignoreMembers: null,
        ignoreMessages: null,
    },
});

Create a starboard:

client.starboardManager.create({
    channelID: message.channelId,
    emoji: "⭐",
    threshold: 10,
    color: "#f0ec0e",
    selfStar: false,
    botStar: false,
    ignoreMembers: null,
    ignoreMessages: null,
});

Delete a starboard:

const starboardID = client.starboardManager.starboards.find(starboard => starboard.channelID == "" && starboard.emoji == "").id;
client.starboardManager.delete(starboardID);

Create a secret starboard:

This ignoreMessages function will ignore all messages that aren't from the specified channels!

client.starboardManager.create({
    channelID: message.channelId,
    emoji: "⭐",
    threshold: 10,
    color: "#f0ec0e",
    selfStar: false,
    botStar: false,
    ignoreMembers: null,
    ignoreMessages: (message => !["channel 1 ID, "channel 2 ID"].includes(message.channelId)),
});

Blacklist a role from starboard:

This ignoreMembers function will not count star reactions from members who have the specified role!

client.starboardManager.create({
    channelID: message.channelId,
    emoji: "⭐",
    threshold: 10,
    color: "#f0ec0e",
    selfStar: false,
    botStar: false,
    ignoreMembers: (member => member.roles.cache.has("role ID")),
    ignoreMessages: null,
});

Events:

// Fired when a message is added to a starboard
client.starboardManager.on("starboardMessagePosted", (message, starboard) => {
    console.log(message); // the message that was posted to the starboard channel
    console.log(starboard); // the starboard that triggered this
}

// Fired when a starboard is created
client.starboardManager.on("starboardCreated", (starboard) => {
    console.log(starboard); // the starboard that was created
}

// Fired when a starboard is deleted
client.starboardManager.on("starboardDeleted", (starboard) => {
    console.log(starboard); // the starboard that was deleted
}

Coming Soon!

  • ability to edit starboard options easily
  • leaderboard for top starboard messages