Skip to content

Latest commit

 

History

History
175 lines (147 loc) · 5.07 KB

README.md

File metadata and controls

175 lines (147 loc) · 5.07 KB
Raw

Discord Message Parser

  • Has zero dependencies.
  • A message parser for discord using regular expressions and string manipulation.
  • If you need help feel free to join our discord server to talk and help you with your code.
  • If you encounter any of those fell free to open an issue in our github repository.

Download & Update

You can download it from npm:

npm i discord-message-parser

You can update to a newer version to receive updates using npm.

npm update discord-message-parser

Changelog

3rd of April (v1.0.0) - Original publication to node package manager.

Setting Up

First things first, we include the module into the project.

const MessageParser = require("discord-message-parser");
const { SpoilerParser, EmojiParser } = MessageParser;

Examples

Examples assume that you have setted up the module as presented in 'Setting Up' section. Following examples assume that your Discord.Client is called client.

Following examples assume that your client.on("message", message is called message.

Following example contains isolated code which you need to integrate in your own command handler.

  • Counting emojis in a message:
client.on("message", (message) => {
  const emojiCount = EmojiParser.countEmojis(message.content);
  console.log(emojiCount);
  /*  Sample output: 
     {
       custom: 1,
       animated: 0,
       unicode: 2,
       total: 3
     }
  */
});
  • Parsing emojis in a message:
client.on("message", (message) => {
  const messageEmojis = EmojiParser.parseEmojis(message.content);
  console.log(messageEmojis);
  /* Sample output:
  {
      custom: [{ name: "doggo", id: "393852367751086090", raw: "<:doggo:393852367751086090>", animated: false, unicode: false }],
      customAnimated: [{ name: "dogdance", id: "663013890376073257", raw: "<:dogdance:663013890376073257>", animated: true, unicode: false }],
      customEmojis: [{ name: "doggo", id: "393852367751086090", raw: "<:doggo:393852367751086090>", animated: false, unicode: false }, { name: "dogdance", id: "663013890376073257", raw: "<:dogdance:663013890376073257>", animated: true, unicode: false }],
      unicode: [{ name: null, id: null, raw: "⏱️", animated: null, unicode: true }, { name: null, id: null, raw: "☕", animated: null, unicode: true }],
      allEmojis: [{ name: "doggo", id: "393852367751086090", raw: "<:doggo:393852367751086090>", animated: false, unicode: false }, { name: "dogdance", id: "663013890376073257", raw: "<:dogdance:663013890376073257>", animated: true, unicode: false }, { name: null, id: null, raw: "⏱️", animated: null, unicode: true }, { name: null, id: null, raw: "☕", animated: null, unicode: true }]
  }
  */
});
  • Parsing spoilers in a message:
client.on("message", (message) => {
  const messageSpoilers = SpoilerParser.parseSpoilers(message.content);
  console.log(messageSpoilers);
  /* Sample Output
  [
    { content: 'is killed', raw: '||is killed||' },
    { content: 'married tom', raw: '||married tom||' }
  ]
  */
});

Is time for you to get creative..

Methods

1. Emoji Parsing API

_parseCustomEmojis - Used internally by the library

Parses the non-animated custom emojis from a string.

EmojiParser._parseCustomEmojis(<Content - String>);
  • Output:
Array<Emoji>

_parseAnimatedCustomEmojis - Used internally by the library

Parses the animated custom emojis from a string.

EmojiParser._parseAnimatedCustomEmojis(<Content - String>);
  • Output:
Array<Emoji>

_parseUnicodeEmojis - Used internally by the library

Parses the unicode emojis from a string.

EmojiParser._parseUnicodeEmojis(<Content - String>);
  • Output:
Array<Emoji>

countEmojis

Counts the amount of emojis found in a string and returns the numbers.

EmojiParser.countEmojis(<Content - String>);
  • Output:
Object

_parseEmoji - Used internally by the library

Parse the custom emoji, both animated and not, and returns an array of 1 (custom emoji, non animated, it's the emoji's id) or 2 elements (first - an a string, specific for animated emojis & then the second it's the emoji's id).

EmojiParser._parseEmoji(<Content - String>);
  • Output:
Array<String>

parseEmojis

Parses the string's emojis and returns them in an object, with emojis grouped into 5 properties (custom, customAnimated, customEmojis, unicode, allEmojis), each of them is an array of emojis.

EmojiParser.parseEmojis(<Content - String>);
  • Output:
Object

2. Spoiler Parsing API

_parseSpoilerContent - Used internally by the library

Parse a spoiler from end to finnish and returns its contents.

SpoilerParser._parseSpoilerContent(<Content - String>);
  • Output:
String

parseSpoilers

Parses all of the spoilers in a string and returns them as an array with objects having content and raw properties.

SpoilerMarser.parseEmojis(<Content - String>);
  • Output:
Array<Object>