@sefinek/random-emoji 1.1.1 โ†’ 1.2.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 (8) hide show
  1. package/CHANGELOG.md +12 -7
  2. package/README.md +37 -29
  3. package/index.js +3 -1
  4. package/json/cats.json +1 -1
  5. package/json/circles.json +1 -0
  6. package/json/hearts.json +1 -1
  7. package/package.json +5 -3
  8. package/test.js +8 -4
package/CHANGELOG.md CHANGED
@@ -1,14 +1,19 @@
1
- ## ๐Ÿ“ฅใƒปVersion v1.1.1 (STABLE)
2
- **1.** Added new function `hearts()` with random cat hearts.
1
+ ## ๐Ÿ“ฅใƒปv1.2.0 (12.05.2022)
2
+ 1. Updated CHANGELOG.md, README.md and package.json.
3
+ 2. Added new function `circles()` with random circles.
4
+ 3. Removed `.slashes`.
3
5
 
4
- ## ๐Ÿ“ฅใƒปVersion v1.0.1
5
- **1.** Added new function `cats()` with random cat emojis.
6
- **2.** Added **CHANGELOG.md** file.
7
- **2.** Changes:
6
+ ## ๐Ÿ“ฅใƒปv1.1.1 (11.05.2022)
7
+ 1. Added new function `hearts()` with random hearts.
8
+
9
+ ## ๐Ÿ“ฅใƒปv1.0.1 (08.05.2022)
10
+ 1. Added new function `cats()` with random cat emojis.
11
+ 2. Added **CHANGELOG.md** file.
12
+ 2. Changes:
8
13
  ```diff
9
14
  - emoji()
10
15
  + emojis()
11
16
  ```
12
17
 
13
- ## ๐Ÿ“ฅใƒปVersion v0.1.0
18
+ ## ๐Ÿ“ฅใƒปv0.1.0 (07.05.2022)
14
19
  First release.
package/README.md CHANGED
@@ -1,15 +1,17 @@
1
- ## โญ โ€ข Information
2
- <p>Returns a random emoticon and its name and type. ๐Ÿˆ ๐Ÿฑ ๐Ÿ™€</p>
3
- <a href="https://www.npmjs.com/package/@sefinek/random-emoji" target="_blank" title="random-emoji - npm" style="text-decoration:none">
4
- <img src="https://img.shields.io/npm/dt/@sefinek/random-emoji.svg?maxAge=3600" alt="npm downloads">
5
- <img src="https://img.shields.io/github/issues/sefinek24/random-emoji" alt="Issues">
6
- <img src="https://img.shields.io/github/last-commit/sefinek24/random-emoji" alt="Last commit">
7
- <img src="https://img.shields.io/github/commit-activity/w/sefinek24/random-emoji" alt="Commit activity">
8
- <img src="https://img.shields.io/github/languages/code-size/sefinek24/random-emoji" alt="Code size">
9
- <img src="https://img.shields.io/tokei/lines/github/sefinek24/random-emoji" alt="Total lines">
10
- </a>
11
-
12
- ## ๐Ÿ“ฅ โ€ข How to install?
1
+ <div align="center">
2
+ <h1>About this package</h1>
3
+ <p>Returns a random emoticon, its name and type. ๐Ÿฑ ๐Ÿ™€ โค๏ธ</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="The number of downloads">
6
+ <img src="https://img.shields.io/github/issues/sefinek24/random-emoji" alt="Issues">
7
+ <img src="https://img.shields.io/github/last-commit/sefinek24/random-emoji" alt="Last commit">
8
+ <img src="https://img.shields.io/github/commit-activity/w/sefinek24/random-emoji" alt="Commit activity">
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
+ </a>
12
+ </div>
13
+
14
+ ## ๐Ÿ“ฅ โ€ข Installation
13
15
  > **$** npm install @sefinek/random-emoji
14
16
 
15
17
  ## ๐Ÿ˜ผ โ€ข Examples
@@ -18,34 +20,40 @@ const random = require('@sefinek/random-emoji');
18
20
 
19
21
  // 1. A single emote
20
22
  console.log(unicode());
21
- // Output ยป ๐Ÿฅฐ
23
+ // > ๐Ÿฅฐ
22
24
 
23
25
  // 2. Random emoji with name and type
24
26
  const emoji = random.emojis();
25
- console.log(`Name: ${emoji.name}; Type: ${emoji.type}; Emoji: ${emoji.content};`);
26
- // Output ยป Name: Cat Face; Type: animal; Emoji: ๐Ÿฑ;
27
-
28
- // 3. Random cats
29
- const cat = cats();
30
- console.log(`Name: ${cat.name}; Slashes: ${cat.slashes}; Emoji: ${cat.content};`);
31
- // Output ยป Name: smiley_cat; Slashes: \\๐Ÿ˜บ; Emoji: ๐Ÿ˜บ;
32
-
33
- // 4. Random hearts
34
- const heart = hearts();
35
- console.log(`Name: ${heart.name}; Slashes: ${heart.slashes}; Emoji: ${heart.content};`);
36
- // Output ยป Name: blue_heart; Slashes: \\๐Ÿ’™; Emoji: ๐Ÿ’™;
27
+ console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
28
+ // > Name: Cat Face; Type: animal; Emoji: ๐Ÿฑ;
29
+
30
+ // 3. Random cat
31
+ const cat = random.cats();
32
+ console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
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: ๐Ÿ”ต;
37
44
  ```
38
45
 
39
- ## ๐Ÿ˜ป โ€ข Functions list
46
+ ## ๐Ÿ˜ป โ€ข Usage
40
47
  ```js
41
48
  emojis() // Random emoji with name and type
42
49
  unicode() // A single emote
43
- cats() // Return random cats
44
- hearts() // Return random hearts
50
+ cats() // Return random cat
51
+ hearts() // Return random heart
52
+ circles() // Return random circle
45
53
  ```
46
54
 
47
55
  ## ๐Ÿ“ โ€ข Changelog
48
- > <a href="https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md" target="_blank">https://github.com/sefinek24/random-emoji/blob/main/CHANGELOG.md</a>
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>
49
57
 
50
58
  ## ๐Ÿค โ€ข Help
51
59
  Open new <a href="https://github.com/sefinek24/random-emoji/issues/new/choose" target="_blank">Issue</a> on Github.
package/index.js CHANGED
@@ -2,8 +2,10 @@ 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 circles = require('./json/circles.json');
5
6
 
6
7
  exports.emojis = () => emojis[Math.floor(Math.random() * emojis.length)];
7
8
  exports.unicode = () => unicode[Math.floor(Math.random() * unicode.length)];
8
9
  exports.cats = () => cats[Math.floor(Math.random() * cats.length)];
9
- exports.hearts = () => hearts[Math.floor(Math.random() * hearts.length)];
10
+ exports.hearts = () => hearts[Math.floor(Math.random() * hearts.length)];
11
+ exports.circles = () => circles[Math.floor(Math.random() * circles.length)];
package/json/cats.json CHANGED
@@ -1 +1 @@
1
- [{"content":"๐Ÿ˜บ","slashes":"\\๐Ÿ˜บ","name":"smiley_cat"},{"content":"๐Ÿ˜ธ","slashes":"\\๐Ÿ˜ธ","name":"smile_cat"},{"content":"๐Ÿ˜น","slashes":"\\๐Ÿ˜น","name":"joy_cat"},{"content":"๐Ÿ˜ป","slashes":"\\๐Ÿ˜ป","name":"heart_eyes_cat"},{"content":"๐Ÿ˜ผ","slashes":"\\๐Ÿ˜ผ","name":"smirk_cat"},{"content":"๐Ÿ˜ฝ","slashes":"\\๐Ÿ˜ฝ","name":"kissing_cat"},{"content":"๐Ÿ™€","slashes":"\\๐Ÿ™€","name":"scream_cat"},{"content":"๐Ÿ˜ฟ","slashes":"\\๐Ÿ˜ฟ","name":"crying_cat_face"},{"content":"๐Ÿ˜พ","slashes":"\\๐Ÿ˜พ","name":"pouting_cat"},{"content":"๐Ÿฑ","slashes":"\\๐Ÿฑ","name":"cat"},{"content":"๐Ÿˆ","slashes":"\\๐Ÿˆ","name":"cat2"},{"content":"๐Ÿˆโ€โฌ›","slashes":"\\๐Ÿˆโ€โฌ›","name":"black_cat"}]
1
+ [{"content":"๐Ÿ˜บ","name":"smiley_cat"},{"content":"๐Ÿ˜ธ","name":"smile_cat"},{"content":"๐Ÿ˜น","name":"joy_cat"},{"content":"๐Ÿ˜ป","name":"heart_eyes_cat"},{"content":"๐Ÿ˜ผ","name":"smirk_cat"},{"content":"๐Ÿ˜ฝ","name":"kissing_cat"},{"content":"๐Ÿ™€","name":"scream_cat"},{"content":"๐Ÿ˜ฟ","name":"crying_cat_face"},{"content":"๐Ÿ˜พ","name":"pouting_cat"},{"content":"๐Ÿฑ","name":"cat"},{"content":"๐Ÿˆ","name":"cat2"},{"content":"๐Ÿˆโ€โฌ›","name":"black_cat"}]
package/json/circles.json ADDED
@@ -0,0 +1 @@
1
+ [{"content":"๐Ÿ”ด","name":"red_circle"},{"content":"๐ŸŸ ","name":"orange_circle"},{"content":"๐ŸŸก","name":"yellow_circle"},{"content":"๐ŸŸข","name":"green_circle"},{"content":"๐Ÿ”ต","name":"blue_circle"},{"content":"๐ŸŸฃ","name":"purple_circle"},{"content":"๐ŸŸค","name":"brown_circle"},{"content":"โšซ","name":"black_circle"},{"content":"โšช","name":"white_circle"}]
package/json/hearts.json CHANGED
@@ -1 +1 @@
1
- [{"content":"๐Ÿ’Œ","slashes":"\\๐Ÿ’Œ","name":"love_letter"},{"content":"๐Ÿ’","slashes":"\\๐Ÿ’","name":"gift_heart"},{"content":"โฃ๏ธ","slashes":"\\โฃ๏ธ","name":"heart_exclamation"},{"content":"๐Ÿ’”","slashes":"\\๐Ÿ’”","name":"broken_heart"},{"content":"โค๏ธโ€๐Ÿ”ฅ","slashes":"\\โค๏ธโ€๐Ÿ”ฅ","name":"heart_on_fire"},{"content":"โค๏ธโ€๐Ÿฉน","slashes":"\\โค๏ธโ€๐Ÿฉน","name":"mending_heart"},{"content":"โค๏ธ","slashes":"\\โค๏ธ","name":"heart"},{"content":"๐Ÿ’›","slashes":"\\๐Ÿ’›","name":"yellow_heart"},{"content":"๐Ÿ’š","slashes":"\\๐Ÿ’š","name":"green_heart"},{"content":"๐Ÿ’™","slashes":"\\๐Ÿ’™","name":"blue_heart"},{"content":"๐Ÿ’œ","slashes":"\\๐Ÿ’œ","name":"purple_heart"},{"content":"๐ŸคŽ","slashes":"\\๐ŸคŽ","name":"brown_heart"},{"content":"๐Ÿ–ค","slashes":"\\๐Ÿ–ค","name":"black_heart"},{"content":"๐Ÿค","slashes":"\\๐Ÿค","name":"white_heart"},{"content":"๐Ÿซ€","slashes":"\\๐Ÿซ€","name":"anatomical_heart"},{"content":"๐Ÿ’’","slashes":"\\๐Ÿ’’","name":"wedding"},{"content":"๐Ÿ’˜","slashes":"\\๐Ÿ’˜","name":"cupid"},{"content":"๐Ÿ’—","slashes":"\\๐Ÿ’—","name":"heartpulse"}]
1
+ [{"content":"๐Ÿ’Œ","name":"love_letter"},{"content":"๐Ÿ’","name":"gift_heart"},{"content":"โฃ๏ธ","name":"heart_exclamation"},{"content":"๐Ÿ’”","name":"broken_heart"},{"content":"โค๏ธโ€๐Ÿ”ฅ","name":"heart_on_fire"},{"content":"โค๏ธโ€๐Ÿฉน","name":"mending_heart"},{"content":"โค๏ธ","name":"heart"},{"content":"๐Ÿ’›","name":"yellow_heart"},{"content":"๐Ÿ’š","name":"green_heart"},{"content":"๐Ÿ’™","name":"blue_heart"},{"content":"๐Ÿ’œ","name":"purple_heart"},{"content":"๐ŸคŽ","name":"brown_heart"},{"content":"๐Ÿ–ค","name":"black_heart"},{"content":"๐Ÿค","name":"white_heart"},{"content":"๐Ÿซ€","name":"anatomical_heart"},{"content":"๐Ÿ’’","name":"wedding"},{"content":"๐Ÿ’˜","name":"cupid"},{"content":"๐Ÿ’—","name":"heartpulse"}]
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sefinek/random-emoji",
3
- "version": "1.1.1",
4
- "description": "Returns a random emoticon and its name and type.",
3
+ "version": "1.2.0",
4
+ "description": "Returns a random emoticon, its name and type.",
5
5
  "main": "index.js",
6
6
  "scripts": {
7
7
  "test": "node test.js"
@@ -20,10 +20,12 @@
20
20
  "cats",
21
21
  "heart",
22
22
  "hearts",
23
+ "circle",
24
+ "circles",
23
25
  "name",
24
26
  "type"
25
27
  ],
26
- "author": "Sefinek",
28
+ "author": "Sefinek (https://skiffybot.xyz)",
27
29
  "license": "MIT",
28
30
  "bugs": {
29
31
  "url": "https://github.com/sefinek24/random-emoji/issues"
package/test.js CHANGED
@@ -1,16 +1,20 @@
1
- const { unicode, emojis, cats, hearts } = require('./index.js');
1
+ const { unicode, emojis, cats, hearts, circles } = require('./index.js');
2
2
 
3
3
  // A single emote
4
4
  console.log(unicode());
5
5
 
6
6
  // Random emoji with name and type
7
7
  const emoji = emojis();
8
- console.log(`Name: ${emoji.name}; Type: ${emoji.type}; Emoji: ${emoji.content};`);
8
+ console.log(`Name: ${emoji.name}; Emoji: ${emoji.content};`);
9
9
 
10
10
  // Random cats
11
11
  const cat = cats();
12
- console.log(`Name: ${cat.name}; Slashes: ${cat.slashes}; Emoji: ${cat.content};`);
12
+ console.log(`Name: ${cat.name}; Emoji: ${cat.content};`);
13
13
 
14
14
  // Random hearts
15
15
  const heart = hearts();
16
- console.log(`Name: ${heart.name}; Slashes: ${heart.slashes}; Emoji: ${heart.content};`);
16
+ console.log(`Name: ${heart.name}; Emoji: ${heart.content};`);
17
+
18
+ // Random circles
19
+ const circle = circles();
20
+ console.log(`Name: ${circle.name}; Emoji: ${circle.content};`);