@sefinek/random-emoji 1.3.0 → 1.4.0

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 (7) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +10 -19
  3. package/README_PL.md +96 -0
  4. package/index.js +3 -6
  5. package/json/foods.json +1 -0
  6. package/package.json +3 -1
  7. package/test.js +11 -7
package/CHANGELOG.md CHANGED
@@ -1,3 +1,9 @@
1
+ ## 📥・v1.4.0 (15.05.2022)
2
+ 1. Added new function `foods()` with random foods.
3
+ 2. Fixes in `kaomoji()`.
4
+ 3. Small fixes in README.md.
5
+ 4. Added Poland version of README.md file.
6
+
1
7
  ## 📥・v1.3.0 (13.05.2022)
2
8
  1. Updated README.md file.
3
9
  2. Added new function `new kaomojis()` with random kaomoji from my [API](https://api.skiffybot.pl). See examples: [[1](https://github.com/sefinek24/random-emoji/blob/main/test.js)] [[2](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis)]
package/README.md CHANGED
@@ -19,7 +19,7 @@
19
19
  const random = require('@sefinek/random-emoji');
20
20
 
21
21
  // 1. A single emote
22
- console.log(unicode());
22
+ console.log(random.unicode());
23
23
  // > 🥰
24
24
 
25
25
  // 2. Random emoji with name and type
@@ -31,27 +31,18 @@ console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
31
31
  const cat = random.cats();
32
32
  console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
33
33
  // > Name: smiley_cat; Emoji: 😺;
34
-
35
- // 4. Random heart
36
- const heart = random.hearts();
37
- console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
38
- // > Name: blue_heart; Emoji: 💙;
39
-
40
- // 5. Random circle
41
- const circle = random.circles();
42
- console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
43
- // > Name: blue_circle; Emoji: 🔵;
44
34
  ```
45
35
 
46
36
  ## 😻 • Usage
47
- | Function | Description |
48
- |-----------------------------------------------------------------------------------|--------------------------------------------------------------|
49
- | [emojis](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Random emoji with name and type |
50
- | [unicode](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | A single emote |
51
- | [cats](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Return random cat |
52
- | [hearts](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Return random heart |
53
- | [circles](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Return random circle |
54
- | [**new** kaomojis](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Return random kaomojis from [API](https://api.skiffybot.xyz) |
37
+ | Function | Description |
38
+ |----------------------------------------------------------------------------|--------------------------------------------------------------|
39
+ | [emojis](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Random emoji with name and type |
40
+ | [unicode](https://github.com/sefinek24/random-emoji/blob/main/test.js) | A single emote |
41
+ | [cats](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Return random cat |
42
+ | [hearts](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Return random heart |
43
+ | [foods](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Return random food |
44
+ | [circles](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Return random circle |
45
+ | [kaomojis](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Return random kaomojis from [API](https://api.skiffybot.xyz) |
55
46
 
56
47
  ## ⛩️ • Kaomojis
57
48
  ### » Async/await example
package/README_PL.md ADDED
@@ -0,0 +1,96 @@
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
+ <img src="https://img.shields.io/tokei/lines/github/sefinek24/random-emoji" alt="Liczba linijek">
11
+ </a>
12
+ </div>
13
+
14
+ ## 📥 • Instalacja
15
+ > **$** npm install @sefinek/random-emoji
16
+
17
+ ## 😼 • Przykłady
18
+ ```js
19
+ const random = require('@sefinek/random-emoji');
20
+
21
+ // 1. Podyńcza emotka
22
+ console.log(random.unicode());
23
+ // > 🥰
24
+
25
+ // 2. Losowe emoji z nazwą i typem
26
+ const emoji = random.emojis();
27
+ console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
28
+ // > Name: Cat Face; Type: animal; Emoji: 🐱;
29
+
30
+ // 3. Losowy kot
31
+ const cat = random.cats();
32
+ console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
33
+ // > Name: smiley_cat; Emoji: 😺;
34
+ ```
35
+
36
+ ## 😻 • Użycie
37
+ | Funkcja | Opis |
38
+ |---------------------------------------------------------------------------|----------------------------------------------------------|
39
+ | [emojis](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Losowe emoji z nazwą i typem |
40
+ | [unicode](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Pojedyncza emotikona |
41
+ | [cats](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Zwraca losowego kota |
42
+ | [hearts](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Zwraca losowe serce |
43
+ | [foods](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Zwraca losowe jedzenie |
44
+ | [circles](https://github.com/sefinek24/random-emoji/blob/main/test.js) | Zwraca losowe kółko |
45
+ | [kaomojis](https://github.com/sefinek24/random-emoji#%EF%B8%8F--kaomojis) | Zwraca losowe kaomoji z [API](https://api.skiffybot.xyz) |
46
+
47
+ ## ⛩️ • Kaomoji
48
+ ### » Przykład Async/await
49
+ ```js
50
+ const random = require('@sefinek/random-emoji');
51
+ const kaomoji = new random.kaomojis();
52
+
53
+ async function example() {
54
+ const uwu = await kaomoji.uwu();
55
+ console.log(uwu.message);
56
+ }
57
+
58
+ example(); // Wykonaj funkcje
59
+ ```
60
+
61
+ ### » Przykład obietnicy
62
+ ```js
63
+ const random = require('@sefinek/random-emoji');
64
+ const kaomoji = new random.kaomojis();
65
+
66
+ kaomoji.love().then(data => console.log(data));
67
+ ```
68
+
69
+ ### » Zwrócony obiekt przez [API](https://api.skiffybot.xyz)
70
+ ```json
71
+ {
72
+ "success": true,
73
+ "status": 200,
74
+ "category": "kaomoji",
75
+ "endpoint": "uwu",
76
+ "message": "🅤🅦🅤"
77
+ }
78
+ ```
79
+
80
+ ### » Punkty końcowe dla Kaomoji
81
+ | Function | Example |
82
+ |-------------------------------------------------------|-----------|
83
+ | [cat](https://api.skiffybot.xyz/api/v1/kaomoji/cat) | (=^-ω-^=) |
84
+ | [dog](https://api.skiffybot.xyz/api/v1/kaomoji/dog) | ଘ(∪・ﻌ・∪)ଓ |
85
+ | [owo](https://api.skiffybot.xyz/api/v1/kaomoji/owo) | 𝓞𝔀𝓞 |
86
+ | [uwu](https://api.skiffybot.xyz/api/v1/kaomoji/uwu) | 𝕌𝕨𝕌 |
87
+ | [love](https://api.skiffybot.xyz/api/v1/kaomoji/love) | ヽ(♡‿♡)ノ |
88
+
89
+ ## 📝 • Lista zmian
90
+ > https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md
91
+
92
+ ## 🤝 • Pomoc
93
+ Otwórz nowy [Issue](https://github.com/sefinek24/random-emoji/issues/new/choose) na GitHubie.
94
+
95
+ ## ⭐ • Dzięki
96
+ Daj [gwiazdkę](https://github.com/sefinek24/random-emoji), jeżeli możesz na stronie GiHub.
package/index.js CHANGED
@@ -2,9 +2,9 @@ const emojis = require('./json/emojis.json');
2
2
  const unicode = require('./json/unicode.json');
3
3
  const cats = require('./json/cats.json');
4
4
  const hearts = require('./json/hearts.json');
5
+ const foods = require('./json/foods.json');
5
6
  const circles = require('./json/circles.json');
6
7
  const { get } = require('https');
7
- const { URL, URLSearchParams } = require('url');
8
8
  const endpoints = require('./api/endpoints.json');
9
9
 
10
10
  function getContent(url) {
@@ -33,11 +33,7 @@ function getContent(url) {
33
33
  class SkiffyBOT {
34
34
  constructor() {
35
35
  Object.keys(endpoints).forEach(endpoint => {
36
- this[endpoint] = async function(queryParams = '') {
37
- const url = new URL(`https://api.skiffybot.xyz/api/v1/${endpoints[endpoint]}`);
38
- queryParams !== '' ? url.search = new URLSearchParams(queryParams) : '';
39
- return await getContent(url.toString());
40
- };
36
+ this[endpoint] = () => getContent(`https://api.skiffybot.xyz/api/v1/${endpoints[endpoint]}`);
41
37
  });
42
38
  }
43
39
  }
@@ -47,6 +43,7 @@ module.exports = {
47
43
  unicode: () => unicode[Math.floor(Math.random() * unicode.length)],
48
44
  cats: () => cats[Math.floor(Math.random() * cats.length)],
49
45
  hearts: () => hearts[Math.floor(Math.random() * hearts.length)],
46
+ foods: () => foods[Math.floor(Math.random() * foods.length)],
50
47
  circles: () => circles[Math.floor(Math.random() * circles.length)],
51
48
  kaomojis: SkiffyBOT,
52
49
  };
package/json/foods.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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sefinek/random-emoji",
3
- "version": "1.3.0",
3
+ "version": "1.4.0",
4
4
  "description": "Returns a random emoticons (name, type) and kaomojis.",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -20,6 +20,8 @@
20
20
  "cats",
21
21
  "heart",
22
22
  "hearts",
23
+ "food",
24
+ "foods",
23
25
  "circle",
24
26
  "circles",
25
27
  "name",
package/test.js CHANGED
@@ -1,27 +1,31 @@
1
- const { unicode, emojis, cats, hearts, circles, kaomojis } = require('./index.js');
1
+ const random = require('./index.js');
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
10
  // Random cats
11
- const cat = cats();
11
+ const cat = random.cats();
12
12
  console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
13
13
 
14
14
  // Random hearts
15
- const heart = hearts();
15
+ const heart = random.hearts();
16
16
  console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
17
17
 
18
+ // Random foods
19
+ const food = random.foods();
20
+ console.log(`Name: ${food.name}; Emoji: ${food.content};`);
21
+
18
22
  // Random circles
19
- const circle = circles();
23
+ const circle = random.circles();
20
24
  console.log(`Name: ${circle.name}; Emoji: ${circle.content};`);
21
25
 
22
26
  // Random kaomoji
23
27
  (async () => {
24
- const kaomoji = new kaomojis();
28
+ const kaomoji = new random.kaomojis();
25
29
  const kaoCat = await kaomoji.cat();
26
30
  console.log(`Cat face: ${kaoCat.message}`);
27
31