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

@deathinside/discord-mentions-js

v1.0.2

Published

Easily extract a member, role, or channel from a Discord mention.

Downloads

5

Readme

About

Easily extract a member, role, or channel from a Discord mention using Discord.js.

Usage

const getMention = require('@deathinside/discord-mentions-js');

var member = getMention('<@!189855563893571595>', someGuild).member;
// Expected: GuildMember

var role = getMention('<@&12345689012345678>', someGuild).role;
// Expected: '12345689012345678' (ID doesn't refer to a valid role)

var id = getMention('<#632684617312370698>').channel;
// Expected: '632684617312370698'

var mention = getMention('not a mention');
// Expected: null

Returns...

  • ...when a valid mention and guild are provided:
    an object with a member, role, or channel property as the mentioned GuildMember/Role/GuildChannel.

  • ...when a valid mention is provided, but the guild parameter is omitted:
    an object with a member, role, or channel property as the ID inside the mention.

  • ...when an invalid mention and valid guild are provided:
    an object with a member, role, or channel property as as the ID inside the mention.

  • ...when an invalid mention is provided, but the guild parameter is omitted:
    null

Example

Using the client's mention as its prefix and implementing a command which requires a mentioned recipient...

const getMention = require('discord-mentions');

client.on('message', message => {
  if (!message.guild || message.author.bot) return;
  
  const args = message.content.trim().split(/\s+/g);
  
  // Ignoring the message if it doesn't start with the client's mention.
  if (getMention(args[0]) !== client.user.id) return;
  
  args.shift();
  const cmd = args[0].toLowerCase();
  
  // Simple hug command - mention a member to hug. This is where
  // 'message.mentions.members.first()' won't help, since it's
  // actually the client every time with this setup.
  if (cmd === 'hug') {
    try {
      // Making sure the first argument is a mention.
      const mention = getMention(args[1], message.guild);
      if (!mention) return await message.channel.send(':x: Please mention a member to hug.');
      
      // Making sure the mention is a member.
      const recipient = mention.member;
      if (!recipient || typeof recipient === 'string') return await message.channel.send(':x: That\'s a mention, but not a member!');
      
      await message.channel.send(`${message.author} hugs ${recipient}!`);
    } catch(err) {
      console.error(err);
    }
  }
});