Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sefinek/random-emoji
A module providing various random emoticons along with their names and types. Additionally, it also includes random kaomoji. ๐ ๐ฑ ๐
https://github.com/sefinek/random-emoji
cat cats circles dog dogs emoji emojis emoticon emoticons foods hearts kaomoji kaomoji-emoticons npm npm-package npm-packages random
Last synced: 16 days ago
JSON representation
A module providing various random emoticons along with their names and types. Additionally, it also includes random kaomoji. ๐ ๐ฑ ๐
- Host: GitHub
- URL: https://github.com/sefinek/random-emoji
- Owner: sefinek
- License: mit
- Created: 2022-05-07T04:15:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-13T00:09:01.000Z (10 months ago)
- Last Synced: 2024-12-06T10:54:36.442Z (17 days ago)
- Topics: cat, cats, circles, dog, dogs, emoji, emojis, emoticon, emoticons, foods, hearts, kaomoji, kaomoji-emoticons, npm, npm-package, npm-packages, random
- Language: JavaScript
- Homepage: https://npmjs.com/package/@sefinek/random-emoji
- Size: 127 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
๐ป About this package ๐ผ
Constantly supported Node.js module providing random emojis, including their names and categories. The module also offers random Japanese kaomojis.
## ๐ฅ โข Installation
```bash
npm install @sefinek/random-emoji
```
## ๐ป โข Usage
| Function | Description |
|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------|
| [unicode](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L4) | Get a single emoji |
| [emojis](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L7) | Get a random emoji with its name and type |
| [cats](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L11) | Get a random cat |
| [hearts](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L14) | Get a random heart |
| [foods](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L18) | Get a random food |
| [circles](https://github.com/sefinek24/random-emoji/blob/f8e6a007717dc5e51adc31b4418bb954e2d364e5/example.js#L22) | Get a random circle |
| [**new** Kaomojis](#kaomoji-endpoints) | Get random kaomojis from the [API](https://api.sefinek.net) |
## ๐ผ โข Examples
```js
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
```js
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
```js
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](https://api.sefinek.net)
```json
{
"success": true,
"status": 200,
"info": {
"category": "kaomoji",
"endpoint": "uwu"
},
"message": "๏ผต๏ฝ๏ผต"
}
```
###
ยป Kaomoji endpoints
| Function | Link to the API | Version | Example |
|----------|:----------------------------------------------------------|:--------|-----------|
| `cat()` | [Click here](https://api.sefinek.net/api/v2/kaomoji/cat) | v2 | (=^-ฯ-^=) |
| `dog()` | [Click here](https://api.sefinek.net/api/v2/kaomoji/dog) | v2 | เฌ(โชใป๏ปใปโช)เฌ |
| `owo()` | [Click here](https://api.sefinek.net/api/v2/kaomoji/owo) | v2 | ๐๐๐ |
| `uwu()` | [Click here](https://api.sefinek.net/api/v2/kaomoji/uwu) | v2 | ๐๐จ๐ |
| `love()` | [Click here](https://api.sefinek.net/api/v2/kaomoji/love) | v2 | ใฝ(โกโฟโก)ใ |
## ๐ โข Changelog
> [Click here](CHANGELOG.md)
## ๐ค โข Help
Need assistance or have questions about this module? Don't hesitate to open a new [Issue](https://github.com/sefinek24/random-emoji/issues/new) 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](https://github.com/sefinek24/random-emoji).
Your support helps me continue to develop this project and provide new and fun emojis to every user.
## ๐ โข [MIT License](LICENSE)
Copyright 2022-2024 ยฉ by [Sefinek](https://sefinek.net). All Rights Reserved.