@sefinek/random-emoji 1.2.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +54 -21
  3. package/README_PL.md +95 -0
  4. package/{json/cats.json → data/emoji/cat.json} +0 -0
  5. package/{json/circles.json → data/emoji/circle.json} +0 -0
  6. package/data/emoji/food.json +1 -0
  7. package/{json/hearts.json → data/emoji/heart.json} +0 -0
  8. package/{json/emojis.json → data/emoji/random.json} +0 -0
  9. package/{json → data/emoji}/unicode.json +0 -0
  10. package/data/endpoints.json +1 -0
  11. package/index.js +47 -11
  12. package/package.json +5 -3
  13. package/test.js +25 -10
package/CHANGELOG.md CHANGED
@@ -1,3 +1,17 @@
1
+ ## 📥・v1.4.1 (02.06.2022)
2
+ 1. Small changes.
3
+
4
+ ## 📥・v1.4.0 (15.05.2022)
5
+ 1. Added new function `foods()` with random foods.
6
+ 2. Fixes in `kaomoji()`.
7
+ 3. Small fixes in README.md.
8
+ 4. Added Poland version of README.md file.
9
+
10
+ ## 📥・v1.3.0 (13.05.2022)
11
+ 1. Updated README.md file.
12
+ 2. Added new function `new kaomojis()` with random kaomoji from my [API](https://api.skiffybot.xyz). See examples: [[1](https://github.com/sefinek24/random-emoji/blob/main/test.js)] [[2](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis)]
13
+ 3. Other changes to [index.js](https://github.com/sefinek24/random-emoji/blob/main/index.js) file.
14
+
1
15
  ## 📥・v1.2.0 (12.05.2022)
2
16
  1. Updated CHANGELOG.md, README.md and package.json.
3
17
  2. Added new function `circles()` with random circles.
package/README.md CHANGED
@@ -1,13 +1,12 @@
1
1
  <div align="center">
2
- <h1>About this package</h1>
3
- <p>Returns a random emoticon, its name and type. 🐱 🙀 ❤️</p>
2
+ <h1>🐱 About this package 🙀</h1>
3
+ <p>Returns a random emoticons (name, type) and kaomojis.</p>
4
4
  <a href="https://www.npmjs.com/package/@sefinek/random-emoji" target="_blank" title="random-emoji - npm" style="text-decoration:none">
5
5
  <img src="https://img.shields.io/npm/dt/@sefinek/random-emoji.svg?maxAge=3600" alt="The number of downloads">
6
6
  <img src="https://img.shields.io/github/issues/sefinek24/random-emoji" alt="Issues">
7
7
  <img src="https://img.shields.io/github/last-commit/sefinek24/random-emoji" alt="Last commit">
8
8
  <img src="https://img.shields.io/github/commit-activity/w/sefinek24/random-emoji" alt="Commit activity">
9
9
  <img src="https://img.shields.io/github/languages/code-size/sefinek24/random-emoji" alt="Code size">
10
- <img src="https://img.shields.io/tokei/lines/github/sefinek24/random-emoji" alt="Total lines">
11
10
  </a>
12
11
  </div>
13
12
 
@@ -19,7 +18,7 @@
19
18
  const random = require('@sefinek/random-emoji');
20
19
 
21
20
  // 1. A single emote
22
- console.log(unicode());
21
+ console.log(random.unicode());
23
22
  // > 🥰
24
23
 
25
24
  // 2. Random emoji with name and type
@@ -31,31 +30,65 @@ console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
31
30
  const cat = random.cats();
32
31
  console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
33
32
  // > Name: smiley_cat; Emoji: 😺;
33
+ ```
34
+
35
+ ## 😻 • Usage
36
+ | Function | Description |
37
+ |----------------------------------------------------------------------------|--------------------------------------------------------------|
38
+ | [emojis](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Random emoji with name and type |
39
+ | [unicode](https://github.com/sefinek24/random-emoji/blob/main/test.js) | A single emote |
40
+ | [cats](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Return random cat |
41
+ | [hearts](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Return random heart |
42
+ | [foods](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Return random food |
43
+ | [circles](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Return random circle |
44
+ | [kaomojis](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Return random kaomojis from [API](https://api.skiffybot.xyz) |
45
+
46
+ ## ⛩️ • Kaomoji
47
+ ### » Async/await example
48
+ ```js
49
+ const random = require('@sefinek/random-emoji');
34
50
 
35
- // 4. Random heart
36
- const heart = random.hearts();
37
- console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
38
- // > Name: blue_heart; Emoji: 💙;
51
+ (async () => {
52
+ const kaomoji = new random.kaomojis();
39
53
 
40
- // 5. Random circle
41
- const circle = random.circles();
42
- console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
43
- // > Name: blue_circle; Emoji: 🔵;
54
+ const uwu = await kaomoji.uwu();
55
+ console.log(`Random UwU: ${uwu.message}`);
56
+ })();
44
57
  ```
45
58
 
46
- ## 😻 • Usage
59
+ ### » Promise example
47
60
  ```js
48
- emojis() // Random emoji with name and type
49
- unicode() // A single emote
50
- cats() // Return random cat
51
- hearts() // Return random heart
52
- circles() // Return random circle
61
+ const random = require('@sefinek/random-emoji');
62
+ const kaomoji = new random.kaomojis();
63
+
64
+ kaomoji.love().then(data => console.log(data));
53
65
  ```
54
66
 
67
+ ### » The returned object from [API](https://api.skiffybot.xyz)
68
+ ```json
69
+ {
70
+ "success": true,
71
+ "status": 200,
72
+ "category": "kaomoji",
73
+ "endpoint": "uwu",
74
+ "message": "🅤🅦🅤"
75
+ }
76
+ ```
77
+
78
+ ### » Kaomoji endpoints
79
+ | Function | Example |
80
+ |-------------------------------------------------------|-----------|
81
+ | [cat](https://api.skiffybot.xyz/api/v1/kaomoji/cat) | (=^-ω-^=) |
82
+ | [dog](https://api.skiffybot.xyz/api/v1/kaomoji/dog) | ଘ(∪・ﻌ・∪)ଓ |
83
+ | [owo](https://api.skiffybot.xyz/api/v1/kaomoji/owo) | 𝓞𝔀𝓞 |
84
+ | [uwu](https://api.skiffybot.xyz/api/v1/kaomoji/uwu) | 𝕌𝕨𝕌 |
85
+ | [love](https://api.skiffybot.xyz/api/v1/kaomoji/love) | ヽ(♡‿♡)ノ |
86
+
55
87
  ## 📝 • Changelog
56
- > <a href="https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md" target="_blank" title="random-emoji/CHANGELOG.md at main · sefinek24/random-emoji">https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md</a>
88
+ > https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md
57
89
 
58
90
  ## 🤝 • Help
59
- Open new <a href="https://github.com/sefinek24/random-emoji/issues/new/choose" target="_blank">Issue</a> on Github.
91
+ Open new [Issue](https://github.com/sefinek24/random-emoji/issues/new/choose) on GitHub.
60
92
 
61
- ### Thank you ❤️
93
+ ## ⭐ • Thank you
94
+ Give a [star](https://github.com/sefinek24/random-emoji) if you can on GitHub page.
package/README_PL.md ADDED
@@ -0,0 +1,95 @@
1
+ <div align="center">
2
+ <h1>🐱 O tym module 🙀</h1>
3
+ <p>Zwraca losowe emotikony (nazwa, typ) i kaomoji.</p>
4
+ <a href="https://www.npmjs.com/package/@sefinek/random-emoji" target="_blank" title="random-emoji - npm" style="text-decoration:none">
5
+ <img src="https://img.shields.io/npm/dt/@sefinek/random-emoji.svg?maxAge=3600" alt="Liczba pobrań">
6
+ <img src="https://img.shields.io/github/issues/sefinek24/random-emoji" alt="Zgłoszone błędy">
7
+ <img src="https://img.shields.io/github/last-commit/sefinek24/random-emoji" alt="Ostatni commit">
8
+ <img src="https://img.shields.io/github/commit-activity/w/sefinek24/random-emoji" alt="Aktywność commitów">
9
+ <img src="https://img.shields.io/github/languages/code-size/sefinek24/random-emoji" alt="Rozmiar kodu">
10
+ </a>
11
+ </div>
12
+
13
+ ## 📥 • Instalacja
14
+ > **$** npm install @sefinek/random-emoji
15
+
16
+ ## 😼 • Przykłady
17
+ ```js
18
+ const random = require('@sefinek/random-emoji');
19
+
20
+ // 1. Podyńcza emotka
21
+ console.log(random.unicode());
22
+ // > 🥰
23
+
24
+ // 2. Losowe emoji z nazwą i typem
25
+ const emoji = random.emojis();
26
+ console.log(`Nazwa: ${emoji.name}; Emoji: ${emoji.content};`);
27
+ // > Nazwa: Cat Face; Type: animal; Emoji: 🐱;
28
+
29
+ // 3. Losowy kot
30
+ const cat = random.cats();
31
+ console.log(`Nazwa: ${cat.name}; Emoji: ${cat.content};`);
32
+ // > Nazwa: smiley_cat; Emoji: 😺;
33
+ ```
34
+
35
+ ## 😻 • Użycie
36
+ | Funkcja | Opis |
37
+ |---------------------------------------------------------------------------|----------------------------------------------------------|
38
+ | [emojis](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Losowe emoji z nazwą i typem |
39
+ | [unicode](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Pojedyncza emotikona |
40
+ | [cats](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Zwraca losowego kota |
41
+ | [hearts](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Zwraca losowe serce |
42
+ | [foods](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Zwraca losowe jedzenie |
43
+ | [circles](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Zwraca losowe kółko |
44
+ | [kaomojis](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Zwraca losowe kaomoji z [API](https://api.skiffybot.xyz) |
45
+
46
+ ## ⛩️ • Kaomoji
47
+ ### » Przykład Async/await
48
+ ```js
49
+ const random = require('@sefinek/random-emoji');
50
+ const kaomoji = new random.kaomojis();
51
+
52
+ (async () => {
53
+ const kaomoji = new random.kaomojis();
54
+
55
+ const uwu = await kaomoji.uwu();
56
+ console.log(`Random UwU: ${uwu.message}`);
57
+ })();
58
+ ```
59
+
60
+ ### » Przykład obietnicy
61
+ ```js
62
+ const random = require('@sefinek/random-emoji');
63
+ const kaomoji = new random.kaomojis();
64
+
65
+ kaomoji.love().then(data => console.log(data));
66
+ ```
67
+
68
+ ### » Zwrócony obiekt przez [API](https://api.skiffybot.xyz)
69
+ ```json
70
+ {
71
+ "success": true,
72
+ "status": 200,
73
+ "category": "kaomoji",
74
+ "endpoint": "uwu",
75
+ "message": "🅤🅦🅤"
76
+ }
77
+ ```
78
+
79
+ ### » Punkty końcowe dla Kaomoji
80
+ | Function | Example |
81
+ |-------------------------------------------------------|-----------|
82
+ | [cat](https://api.skiffybot.xyz/api/v1/kaomoji/cat) | (=^-ω-^=) |
83
+ | [dog](https://api.skiffybot.xyz/api/v1/kaomoji/dog) | ଘ(∪・ﻌ・∪)ଓ |
84
+ | [owo](https://api.skiffybot.xyz/api/v1/kaomoji/owo) | 𝓞𝔀𝓞 |
85
+ | [uwu](https://api.skiffybot.xyz/api/v1/kaomoji/uwu) | 𝕌𝕨𝕌 |
86
+ | [love](https://api.skiffybot.xyz/api/v1/kaomoji/love) | ヽ(♡‿♡)ノ |
87
+
88
+ ## 📝 • Lista zmian
89
+ > https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md
90
+
91
+ ## 🤝 • Pomoc
92
+ Otwórz nowy [Issue](https://github.com/sefinek24/random-emoji/issues/new/choose) na GitHubie.
93
+
94
+ ## ⭐ • Dzięki
95
+ Daj [gwiazdkę](https://github.com/sefinek24/random-emoji), jeżeli możesz na stronie GitHub.
package/{json/cats.json → data/emoji/cat.json} RENAMED
File without changes
package/{json/circles.json → data/emoji/circle.json} RENAMED
File without changes
package/data/emoji/food.json ADDED
@@ -0,0 +1 @@
1
+ [{"content":"🍕","name":"pizza"},{"content":"🍔","name":"hamburger"},{"content":"🍟","name":"fries"},{"content":"🌭","name":"hotdog"},{"content":"🍿","name":"popcorn"},{"content":"🥓","name":"bacon"},{"content":"🥚","name":"egg"},{"content":"🧇","name":"waffle"},{"content":"🥞","name":"pancakes"},{"content":"🧈","name":"butter"},{"content":"🍞","name":"bread"},{"content":"🥐","name":"croissant"},{"content":"🥨","name":"pretzel"},{"content":"🥯","name":"bagel"},{"content":"🥖","name":"french_bread"},{"content":"🫓","name":"flatbread"},{"content":"🧀","name":"cheese"},{"content":"🥗","name":"salad"},{"content":"🥙","name":"stuffed_flatbread"},{"content":"🥪","name":"sandwich"},{"content":"🌮","name":"taco"},{"content":"🌯","name":"burrito"},{"content":"🫔","name":"tamale"},{"content":"🍖","name":"meat_on_bone"},{"content":"🍗","name":"poultry_leg"},{"content":"🥩","name":"cut_of_meat"},{"content":"🍚","name":"rice"},{"content":"🍛","name":"curry"},{"content":"🥘","name":"shallow_pan_of_food"},{"content":"🍲","name":"stew"},{"content":"🫕","name":"fondue"},{"content":"🍝","name":"spaghetti"},{"content":"🥝","name":"kiwi"},{"content":"🍇","name":"grapes"},{"content":"🍈","name":"melon"},{"content":"🍉","name":"watermelon"},{"content":"🍊","name":"tangerine"},{"content":"🍋","name":"lemon"},{"content":"🍌","name":"banana"},{"content":"🍍","name":"pineapple"},{"content":"🥭","name":"mango"},{"content":"🍎","name":"apple"},{"content":"🍏","name":"green_apple"},{"content":"🍐","name":"pear"},{"content":"🍑","name":"peach"},{"content":"🍒","name":"cherries"},{"content":"🍓","name":"strawberry"},{"content":"🫐","name":"blueberries"},{"content":"🍅","name":"tomato"},{"content":"🧅","name":"onion"},{"content":"🥕","name":"carrot"},{"content":"🥔","name":"potato"}]
package/{json/hearts.json → data/emoji/heart.json} RENAMED
File without changes
package/{json/emojis.json → data/emoji/random.json} RENAMED
File without changes
package/{json → data/emoji}/unicode.json RENAMED
File without changes
package/data/endpoints.json ADDED
@@ -0,0 +1 @@
1
+ {"cat":"kaomoji/cat","dog":"kaomoji/dog","owo":"kaomoji/owo","uwu":"kaomoji/uwu","love":"kaomoji/love"}
package/index.js CHANGED
@@ -1,11 +1,47 @@
1
- const emojis = require('./json/emojis.json');
2
- const unicode = require('./json/unicode.json');
3
- const cats = require('./json/cats.json');
4
- const hearts = require('./json/hearts.json');
5
- const circles = require('./json/circles.json');
6
-
7
- exports.emojis = () => emojis[Math.floor(Math.random() * emojis.length)];
8
- exports.unicode = () => unicode[Math.floor(Math.random() * unicode.length)];
9
- exports.cats = () => cats[Math.floor(Math.random() * cats.length)];
10
- exports.hearts = () => hearts[Math.floor(Math.random() * hearts.length)];
11
- exports.circles = () => circles[Math.floor(Math.random() * circles.length)];
1
+ const emojis = require('./data/emoji/random.json');
2
+ const unicode = require('./data/emoji/unicode.json');
3
+ const cats = require('./data/emoji/cat.json');
4
+ const hearts = require('./data/emoji/heart.json');
5
+ const foods = require('./data/emoji/food.json');
6
+ const circles = require('./data/emoji/circle.json');
7
+ const endpoints = require('./data/endpoints.json');
8
+ const { get } = require('node:https');
9
+
10
+ function getContent(url) {
11
+ return new Promise((resolve, reject) => {
12
+ get(url, res => {
13
+ if (res.statusCode !== 200) {
14
+ reject(`Request failed with status code ${res.statusCode}.`);
15
+ }
16
+
17
+ res.setEncoding('utf8');
18
+ let rawData = '';
19
+ res.on('data', chunk => rawData = chunk);
20
+ res.on('end', () => {
21
+ try {
22
+ resolve(JSON.parse(rawData));
23
+ } catch (err) {
24
+ reject(err.message);
25
+ }
26
+ });
27
+ }).on('error', err => reject(err.message));
28
+ });
29
+ }
30
+
31
+ class SkiffyAPI {
32
+ constructor() {
33
+ Object.keys(endpoints).forEach(endpoint => {
34
+ this[endpoint] = () => getContent(`https://api.skiffybot.xyz/api/v1/${endpoints[endpoint]}`);
35
+ });
36
+ }
37
+ }
38
+
39
+ module.exports = {
40
+ emojis: () => emojis[Math.floor(Math.random() * emojis.length)],
41
+ unicode: () => unicode[Math.floor(Math.random() * unicode.length)],
42
+ cats: () => cats[Math.floor(Math.random() * cats.length)],
43
+ hearts: () => hearts[Math.floor(Math.random() * hearts.length)],
44
+ foods: () => foods[Math.floor(Math.random() * foods.length)],
45
+ circles: () => circles[Math.floor(Math.random() * circles.length)],
46
+ kaomojis: SkiffyAPI,
47
+ };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sefinek/random-emoji",
3
- "version": "1.2.0",
4
- "description": "Returns a random emoticon, its name and type.",
3
+ "version": "1.4.1",
4
+ "description": "Returns a random emoticons (name, type) and kaomojis.",
5
5
  "main": "index.js",
6
6
  "scripts": {
7
7
  "test": "node test.js"
@@ -20,12 +20,14 @@
20
20
  "cats",
21
21
  "heart",
22
22
  "hearts",
23
+ "food",
24
+ "foods",
23
25
  "circle",
24
26
  "circles",
25
27
  "name",
26
28
  "type"
27
29
  ],
28
- "author": "Sefinek (https://skiffybot.xyz)",
30
+ "author": "Sefinek <contact@sefinek.fun>",
29
31
  "license": "MIT",
30
32
  "bugs": {
31
33
  "url": "https://github.com/sefinek24/random-emoji/issues"
package/test.js CHANGED
@@ -1,20 +1,35 @@
1
- const { unicode, emojis, cats, hearts, circles } = require('./index.js');
1
+ const random = require('./');
2
2
 
3
3
  // A single emote
4
- console.log(unicode());
4
+ console.log(random.unicode());
5
5
 
6
6
  // Random emoji with name and type
7
- const emoji = emojis();
7
+ const emoji = random.emojis();
8
8
  console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
9
9
 
10
- // Random cats
11
- const cat = cats();
10
+ // Random cat
11
+ const cat = random.cats();
12
12
  console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
13
13
 
14
- // Random hearts
15
- const heart = hearts();
14
+ // Random heart
15
+ const heart = random.hearts();
16
16
  console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
17
17
 
18
- // Random circles
19
- const circle = circles();
20
- console.log(`Name: ${circle.name}; Emoji: ${circle.content};`);
18
+ // Random food
19
+ const food = random.foods();
20
+ console.log(`Name: ${food.name}; Emoji: ${food.content};`);
21
+
22
+ // Random circle
23
+ const circle = random.circles();
24
+ console.log(`Name: ${circle.name}; Emoji: ${circle.content};`);
25
+
26
+ // Random kaomoji
27
+ (async () => {
28
+ const kaomoji = new random.kaomojis();
29
+
30
+ const kaoCat = await kaomoji.cat();
31
+ console.log(`Cat face: ${kaoCat.message}`);
32
+
33
+ const uwu = await kaomoji.uwu();
34
+ console.log(`Random UwU: ${uwu.message}`);
35
+ })();