Merge pull request #4 from sinansonmez/feature/add-random-emoji-gener…

…ator

Feature:Add random emoji generator

.github/workflows/publish.yml

@@ -13,6 +13,7 @@ jobs:
           node-version: 16
       - run: npm ci
       - run: npm test
+      - run: npm run lint
       - run: npm run build
 
   publish-npm:

README.md

@@ -18,9 +18,17 @@ countryCodeToFlag('US'); // returns '🇺🇸'
 flagToCountryCode('🇺🇸'); // returns 'US'
 
 
-const { letterToEmoji, emojiToLetter } = require('easy-emojis');
+const { letterToEmoji, emojiToLetter, getRandomEmoji } = require('easy-emojis');
 letterToEmoji('S'); // returns '🇸'
 emojiToLetter('🇸') // returns 'S'
+
+const { getRandomEmoji } = require('easy-emojis');
+getRandomEmoji(); // should return a random emoji
+```
+## alternative importing
+```javascript
+import * as EasyEmojis from 'easy-emojis';
+EasyEmojis.countryCodeToFlag('US'); // returns '🇺🇸'
 ```
 
 ### Run tests

package.json

@@ -1,6 +1,6 @@
 {
   "name": "easy-emojis",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "A simple library to create emojis (flag or letter)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/__tests__/index.test.ts

@@ -1,4 +1,5 @@
-import {countryCodeToFlag, emojiToLetter, flagToCountryCode, letterToEmoji} from '../index';
+import emojis from '../emojis';
+import {countryCodeToFlag, emojiToLetter, flagToCountryCode, letterToEmoji, getRandomEmoji} from '../index';
 
 test('countryCodeToEmoji', () => {
   expect(countryCodeToFlag('US')).toBe('🇺🇸');
@@ -27,3 +28,9 @@ test('letterToEmoji with input less than single character', () => {
 test('emojiToLetter', () => {
   expect(emojiToLetter('🇦')).toBe('A');
 });
+
+test('should return a different emoji on subsequent calls', () => {
+  const emoji1 = getRandomEmoji();
+  const emoji2 = getRandomEmoji();
+  expect(emoji1).not.toEqual(emoji2);
+});

src/index.ts

@@ -1,3 +1,5 @@
+import emojis from "./emojis";
+
 // offset between uppercase ascii and regional indicator symbols
 const OFFSET = 127397;
 
@@ -17,3 +19,8 @@ export const letterToEmoji = (letter: string): string => {
 export const emojiToLetter = (emoji: string): string => {
   return String.fromCodePoint(emoji.codePointAt(0)! - OFFSET);
 };
+
+export const getRandomEmoji = (): string => {
+  const randomIndex = Math.floor(Math.random() * emojis.length);
+  return emojis[randomIndex].unicode;
+}