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

cherry-giveaways

v1.1.8

Published

A npm package that creates giveaways.

Downloads

4

Readme

Click Here

Update 25/1/2021

You can now do

const Creator = new GiveawayCreator(client, 'mongodb://...', 'unicode emoji');

For custom emojis.

discord-giveaway

A package for giveaways and drops.

Drops

Go here to see how to use the drops.

Examples

Giveaway Drop

Start

Start by creating a new GiveawayCreator.

const { Client } = require('discord.js');
const client = new Client();
const { GiveawayCreator } = require('discord-giveaway');
const Creator = new GiveawayCreator(client, 'mongodb://...');

client.giveaways = Creator; // Access the Creator from anywhere.

All Methods

startGiveaway(options)

Creates a giveaway. Example:

client.on('message', async message => {
    if (message.content.startsWith('!create')) {
        const channel = message.mentions.channels.first();
        await client.giveaways.startGiveaway({
            prize: 'Discord Nitro Classic',
            channelId: channel.id,
            guildId: message.guild.id,
            duration: 30000, // 30 Seconds
            winners: 1, // 1 winner
            hostedBy: message.author.id
        });
    }
});
endGiveaway(messageId)

Ends a giveaway. Example:

client.on('message', async message => {
    if (message.content.startsWith('!end')) {
        const args = message.content.split(' ').slice(1);
        const ended = await client.giveaways.endGiveaway(args.join(' '));
        
        if (!ended) {
            return message.channel.send('This giveaway has already ended');
        }
        else {
            message.channel.send('Ended the giveaway');
        }
    }
});
rerollGiveaway(messageId)

Rerolls a giveaway. Example:

client.on('message', async message => {
    if (message.content.startsWith('!end')) {
        const args = message.content.split(' ').slice(1);
        const rerolled = await client.giveaways.rerollGiveaway(args.join(' '));
        
        if (!rerolled) {
            return message.channel.send('This giveaway hasn\'t ended');
        }
        else {
            message.channel.send('Rerolled the giveaway');
        }
    }
});
listGiveaways(guildId)
const prettyMilliseconds = require('pretty-ms'); // npm i pretty-ms

client.on('message', async message => {
    if (message.content.startsWith('!list')) {
        const list = await client.giveaways.listGiveaways(message.guild.id);
        
        if (!list) {
            return message.channel.send('No active giveaways.');
        } else {
            message.channel.send(`${list.map(i => `\`${i.messageId}\` - **${i.prize}** | ${prettyMilliseconds(i.timeRemaining)} | Host: **${i.hostedBy}**`).join('\n')}`)
        }
    }
});

How to Use Drops

First, you need to create a new DropCreator.

const Discord = require('discord.js');
const client = new Discord.Client();
const Giveaway = require('discord-giveaway');
const DropCreator = new Giveaway.DropCreator(client, 'mongodb://...');

Drop Methods

createDrop(options)

Creates a drop. Example:

const channel = message.mentions.channels.first();
const newDrop = await DropCreator.createDrop({
    prize: 'Discord Nitro',
    guildId: message.guild.id,
    channelId: channel.id,
    createdBy: message.author.id
});

message.channel.send(`Created a drop in ${channel}. The prize is **${newDrop.prize}**`);
deleteDrop(guildId, position)

Deletes a drop. Find the position by using the listDrops() method.

const args = message.content.split(' ').slice(1);

const deleted = await DropCreator.deleteDrop(message.guild.id, parseInt(args[0]));

if (!deleted) {
    return message.channel.send('Doesn\'t exist :/');
}

message.channel.send('Deleted the Drop');
listDrops(guildId)

Lists all the drops in a guild.

const { MessageEmbed } = require('discord.js');
const list = await DropCreator.listDrops(message.guild.id);

if (!list) {
    return message.channel.send('No Drops :/');
}

const mapped = list.map(i => `**${i.position}.** Channel: ${i.channel} | Prize: ${i.prize}`);

const embed = new MessageEmbed()
.setTitle('List of Drops')
.setDescription(`${mapped.join('\n')}`)
.setColor(message.guild.me.roles.highest.hexColor)
.setFooter(client.user.tag, client.user.displayAvatarURL({ format: 'png', size: 512 }));

message.channel.send(embed);

Events

Here are some events you can use for the drops and giveaways.

const { Client } = require('discord.js');
const client = new Client();
const { GiveawayCreator, DropCreator } = require('discord-giveaway');
const giveaways = new GiveawayCreator(client, 'mongodb://...');
const drops = new DropCreator(client, 'mongodb://...');

client.login('some-token');

DropCreator.on('dropCreate', drop => console.log(`New drop created with the prize of ${drop.prize}`));
DropCreator.on('dropDelete', drop => console.log(`Deleted the ${drop.prize} drop.`));
DropCreator.on('wonDrop', drop => console.log(`Someone won the ${drop.prize} drop.`));

GiveawayCreator.on('giveawayEnd', giveaway => {
    console.log(`The ${giveaway.prize} giveaway has ended at ${giveaway.endsOn}.`);
});

GiveawayCreator.on('giveawayStart', giveaway => {
    console.log(`${giveaway.prize} giveaway has been scheduled for ${giveaway.endsOn}.`);
});

GiveawayCreator.on('giveawayReroll', giveaway => {
    console.log(`Rerolled the ${giveaway.prize} giveaway.`);
});

Properties

Giveaway Properties

guildId

The guild ID of the giveaway.

channelId

The channel ID of the giveaway.

hostedBy

The ID of the person who hosted the giveaway.

messageId

The message ID of the giveaway.

startsOn

A date of when the giveaway started.

endsOn

A date of when the giveaway will end.

winners

The amount of winners the giveaway can have.

hasEnded

Whether the giveaway has ended.

duration

The duration of the giveaway in milliseconds.

prize

The prize of the giveaway.

Drop Properties

guildId

The guild ID of the drop.

channelId

The channel ID of the drop.

prize

The prize of the drop.

createdBy

The ID of the person who created the drop.

timeCreated

The date when the drop was created.

position

The position of the drop.