Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/modcord/message-parser
A message parser for discord using regular expressions and string manipulation.
https://github.com/modcord/message-parser
custom-emoji discord message-parser parsing-spoilers string-manipulation
Last synced: about 2 months ago
JSON representation
A message parser for discord using regular expressions and string manipulation.
- Host: GitHub
- URL: https://github.com/modcord/message-parser
- Owner: ModCord
- License: mit
- Created: 2020-04-29T11:15:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T06:37:36.000Z (almost 2 years ago)
- Last Synced: 2024-11-11T16:04:39.649Z (about 2 months ago)
- Topics: custom-emoji, discord, message-parser, parsing-spoilers, string-manipulation
- Language: TypeScript
- Homepage:
- Size: 839 KB
- Stars: 3
- Watchers: 4
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```cli
npm i discord-message-parser
```
You can update to a newer version to receive updates using npm.
```cli
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.
```js
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:**
```js
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:**
```js
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:**
```js
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.
```js
EmojiParser._parseCustomEmojis();
```
- Output:
```
Array
```
**\_parseAnimatedCustomEmojis** - *Used internally by the library*
Parses the animated custom emojis from a string.
```js
EmojiParser._parseAnimatedCustomEmojis();
```
- Output:
```
Array
```
**\_parseUnicodeEmojis** - *Used internally by the library*
Parses the unicode emojis from a string.
```js
EmojiParser._parseUnicodeEmojis();
```
- Output:
```
Array
```
**countEmojis**
Counts the amount of emojis found in a string and returns the numbers.
```js
EmojiParser.countEmojis();
```
- 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).
```js
EmojiParser._parseEmoji();
```
- Output:
```
Array
```
**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.
```js
EmojiParser.parseEmojis();
```
- Output:
```
Object
```
## 2. Spoiler Parsing API
**\_parseSpoilerContent** - *Used internally by the library*
Parse a spoiler from end to finnish and returns its contents.
```js
SpoilerParser._parseSpoilerContent();
```
- Output:
```
String
```
**parseSpoilers**
Parses all of the spoilers in a string and returns them as an array with objects having `content` and `raw` properties.
```js
SpoilerMarser.parseEmojis();
```
- Output:
```
Array
```