📥 • Installation

npm install @sefinek/random-emoji

😻 • Usage

| Function | Description | |-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| | unicode | Get a single emoji | | emojis | Get a random emoji with its name and type | | cats | Get a random cat | | hearts | Get a random heart | | foods | Get a random food | | circles | Get a random circle | | new Kaomojis | Get random kaomojis from the API |

😼 • Examples

const random = require('@sefinek/random-emoji');

// 1. A single emoji
console.log(random.unicode()); // 🥰

// 2. Random emoji along with its visual representation, name, and category
const emoji = random.emojis();
console.log(`Emoji: ${emoji.content}; Name: ${emoji.name}; Type: ${emoji.type}`);
// Emoji: 🐶; Name: Dog Face; Type: animal

// 3. Random cat
const cat = random.cats();
console.log(`Emoji: ${cat.content}; Name: ${cat.name}`);
// Emoji: 😺; Name: smiley_cat

⛩️ • Kaomojis

» Async/await example

const random = require('@sefinek/random-emoji');

(async () => {
    const kaomoji = new random.Kaomojis();

    const uwu = await kaomoji.uwu();
    console.log('Random UwU:', uwu.message);
})();

» Promise example

const random = require('@sefinek/random-emoji');
const kaomoji = new random.Kaomojis();

kaomoji.uwu().then(data => console.log(data));
// or shorter
kaomoji.uwu().then(console.log);

» The returned object from API

{
  "success": true,
  "status": 200,
  "info": {
    "category": "kaomoji",
    "endpoint": "uwu"
  },
  "message": "ＵｗＵ"
}

» Kaomoji endpoints

| Function | Link to the API | Version | Example | |----------|:----------------------------------------------------------|:--------|-----------| | cat() | Click here | v2 | (=^-ω-^=) | | dog() | Click here | v2 | ଘ(∪・ﻌ・∪)ଓ | | owo() | Click here | v2 | 𝓞𝔀𝓞 | | uwu() | Click here | v2 | 𝕌𝕨𝕌 | | love() | Click here | v2 | ヽ(♡‿♡)ノ |

📝 • Changelog

Click here

🤝 • Help

Need assistance or have questions about this module? Don't hesitate to open a new Issue on our GitHub repository. Our community is ready to help and provide answers to your inquiries.

⭐ • Thank you

If you use the Random Emoji module and appreciate my work, I'd be grateful if you could give it a star on our GitHub page. Your support helps me continue to develop this project and provide new and fun emojis to every user.

🎓 • MIT License

Copyright 2023 © by Sefinek. All Rights Reserved.