quickboard

Hi! Welcome to Quickboard. 👋

This package is a simple and easy to create leaderboard. If you're using Discord.js, you can use this package to create a leaderboard like Top 10 of the server.

Installation

Node.js 16.6.0 or newer is required.

npm install quickboard@latest

Simple Instance

const QuickBoard = require('quickboard');
const board = new QuickBoard({
  max: 10,
  data: client.guilds.cache.get('123456789012345678').members.cache.map(member => ({ value: database.fetch(`message-count.${member.user.id}`), member })), // client = discord.js client, database = quick.db
  map: (item, index) => `${index + 1}. ${item.member.displayName} - ${item.value} messages`,
  sort: (according, current) => current.value - according.value,
}).create();

console.log(board);

Example Output

1. Discord#0000 23245 messages
2. Discord#0000 7754 messages
3. Discord#0000 3576 messages
4. Discord#0000 2256 messages
5. Discord#0000 1123 messages
6. Discord#0000 975 messages
7. Discord#0000 566 messages
8. Discord#0000 500 messages
9. Discord#0000 234 messages
10. Discord#0000 100 messages

News

• Published.
• Added types (v1.4.0)
• Added some nice touaches (v1.4.5)

Contact