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

@purplet/utils

v1.0.0

Published

Utilities for Discord API driven development.

Downloads

58

Readme

@purplet/utils

This package contains a variety of utilities for interfacing with the Discord API, such as functions to format @mentions, parse snowflake IDs, builder classes to generate certain JSON structures, API constants, and more. It's designed to be useful to anyone interacting with the Discord API.

If you are using the Purplet Framework, everything from this package is re-exported from the purplet import. Use that instead of installing this alongside your project.

Installing

@purplet/utils has a peer-dependency on discord-api-types so we do not have to bump this package when types change slightly.

pnpm install @purplet/utils discord-api-types
# or
bun add @purplet/utils discord-api-types

Features

Here is a subset of the utilities that are available in this package:

Mention formatters

The following functions generate markdown mentions.

  • userMention(id or object)
  • channelMention(id or object)
  • roleMention(id or object)
  • slashCommandMention(command object)
  • emojiMention(emoji partial object)
  • timestampMention(date, format?)
const user = await rest.user.getCurrentUser();
console.log(`I'm ${userMention(user)}`); // I'm <@778616916092125206>

Snowflakes

snowflakeToDate and dateToSnowflake allow conversion between snowflake IDs and dates.

Builders and JSONResolvable

JSONResolvable<T> is a special type that allows a plain json object to contain builder classes to be placed anywhere within another interface, as JSON.stringify will call the .toJSON method on any classes that attempt to get stringified. In the example below, this is used with APIMessage to allow component helpers.

import { APIMessage } from 'discord-api-types/v10';
import { JSONResolvable, toJSONValue, MessageComponentBuilder, createLinkButton } from '@purplet/utils';
import { Rest } from '@purplet/rest';

const messageData: JSONResolvable<APIMessage> = {
  content: 'Here are my socials!',
  components: new MessageComponentBuilder()
    .addInline(createLinkButton('Web', 'https://purplet.js.org'))
    .addInline(createLinkButton('Discord', 'https://discord.gg/C7fpBDJDtC')),
};

messageData.components // a MessageComponentBuilder instance

// toJSONValue flattens the object without converting to a string.
// use `JSON.stringify` if you need a string value.
const rawMessage = toJSONValue(messageData);

messageData.components // an array of JSON objects.

const rest = new Rest({ token: '<token>' });
rest.channel.createMessage({
  channelId: '<channel>',
  // Most Purplet APIs accept JSONResolvable variants directly. The
  // manual step is only shown to illustrate the concept.
  body: rawMessage
});