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

@dumbmoron/discordwebhook

v0.0.2

Published

library for sending messages through discord's webhook API

Downloads

8

Readme

@dumbmoron/discordwebhook

fork of @matthew1232/discord-webhook-node that uses native node.js fetch (aka undici) and has no dependencies

recommended node version: >=19

npm

Installation

npm install @dumbmoron/discordwebhook or yarn add @dumbmoron/discordwebhook

Examples

Basic use

const { Webhook } = require('@dumbmoron/discordwebhook');
const hook = new Webhook("YOUR WEBHOOK URL");

const IMAGE_URL = 'https://homepages.cae.wisc.edu/~ece533/images/airplane.png';
hook.setUsername('Webhook Node Name');
hook.setAvatar(IMAGE_URL);

hook.send("Hello there!");

Custom embeds

const { Webhook, MessageBuilder } = require('@dumbmoron/discordwebhook');
const hook = new Webhook("YOUR WEBHOOK URL");

const embed = new MessageBuilder()
                    .setTitle('My title here')
                    .setAuthor('Author here', 'https://cdn.discordapp.com/embed/avatars/0.png', 'https://www.google.com')
                    .setURL('https://www.google.com')
                    .addField('First field', 'this is inline', true)
                    .addField('Second field', 'this is not inline')
                    .setColor('#00b0f4')
                    .setThumbnail('https://cdn.discordapp.com/embed/avatars/0.png')
                    .setDescription('Oh look a description :)')
                    .setImage('https://cdn.discordapp.com/embed/avatars/0.png')
                    .setFooter('Hey its a footer', 'https://cdn.discordapp.com/embed/avatars/0.png')
                    .setTimestamp();

hook.send(embed);

Keep in mind that the custom embed method setColor takes in a decimal color/a hex color (pure black and white hex colors will be innacurate). You can convert hex colors to decimal using this website here: https://convertingcolors.com

Sending files

const { Webhook } = require('@dumbmoron/discordwebhook');
const hook = new Webhook('YOUR WEBHOOK URL');

hook.sendFile('../yourfilename.png');

Preset messages

const { Webhook } = require('@dumbmoron/discordwebhook');
const hook = new Webhook('YOUR WEBHOOK URL');

//Sends an information message
hook.info('**Information hook**', 'Information field title here', 'Information field value here');

//Sends a success message
hook.success('**Success hook**', 'Success field title here', 'Success field value here');

//Sends an warning message
hook.warning('**Warning hook**', 'Warning field title here', 'Warning field value here');

//Sends an error message
hook.error('**Error hook**', 'Error field title here', 'Error field value here');

Custom settings

const { Webhook } = require('@dumbmoron/discordwebhook');
const hook = new Webhook("https://discord.com/api/webhooks/...");

hook.setUsername('Username'); // Overrides the default webhook username
hook.setAvatar('YOUR_AVATAR_URL'); //Overrides the default webhook avatar

Notes

@dumbmoron/discordwebhook is a promise based library, which means you can use .catch, .then, and await, although if successful will not return any values. For example:

const { Webhook } = require('@dumbmoron/discordwebhook');
const hook = new Webhook("YOUR WEBHOOK URL");

hook.send("Hello there!")
    .then(() => console.log('Sent webhook successfully!'))
    .catch(err => console.log(err.message));

or using async:

const { Webhook } = require('@dumbmoron/discordwebhook');
const hook = new Webhook("YOUR WEBHOOK URL");

(async () => {
    try {
        await hook.send('Hello there!');
        console.log('Successfully sent webhook!');
    } catch(e) {
        console.log(e.message);
    };
})();

By default, it will handle Discord's rate limiting, and if there is an error sending the message (other than rate limiting), an error will be thrown. You can change these options with the custom settings options below.

API

Webhook - class

Constructor

  • url : string

Methods

  • setUsername(username : string) returns this
  • setAvatar(avatarURL : string (image url)) returns this
  • async sendFile(filePath : string)
  • async send(payload : string/MessageBuilder)
  • async info(title : string, fieldName (optional) : string, fieldValue (optional) : string, inline (optional) : boolean)
  • async success(title : string, fieldName (optional) : string, fieldValue (optional) : string, inline (optional) : boolean)
  • async warning(title : string, fieldName (optional) : string, fieldValue (optional) : string, inline (optional) : boolean)
  • async error(title : string, fieldName (optional) : string, fieldValue (optional) : string, inline (optional) : boolean)

MessageBuilder - class

Methods

  • setText(text: string)
  • setAuthor(author: string (text), authorImage (optional) : string (image url), authorUrl (optional) : string (link))
  • setTitle(title: string)
  • setURL(url: string)
  • setThumbnail(thumbnail : string (image url))
  • setImage(image : string (image url))
  • setTimestamp(date (optional) number/date object)
  • setColor(color : string/number (hex or decimal color))
  • setDescription(description : string)
  • addField(fieldName : string, fieldValue: string, inline (optional) : boolean)
  • setFooter(footer : string, footerImage (optional) : string (image url))