feat: add internet.emoji

Author: hugoattal

README.md

@@ -333,6 +333,7 @@ Faker provides many useful utility functions.
   | color        | Generates a random hexadecimal color                 |
   | mac          | Generates a random mac address                       |
   | password     | Generates a random password                          |
+  | emoji        | Generates a random emoji                             |
 
 - faker.lorem
 

src/definitions/internet.ts

@@ -16,6 +16,22 @@ export interface InternetDefinitions {
    * Some free-mail domains used in that country (e.g. `gmail.de`).
    */
   free_email: string[];
+  /**
+   * List of all fully-qualified emoji ordered by groups.
+   */
+  emoji: {
+    [key in
+      | 'smileys'
+      | 'body'
+      | 'person'
+      | 'nature'
+      | 'food'
+      | 'travel'
+      | 'activities'
+      | 'objects'
+      | 'symbols'
+      | 'flags']: string[];
+  };
 }
 
 /**
@@ -24,5 +40,6 @@ export interface InternetDefinitions {
 export const INTERNET = allOf<keyof InternetDefinitions>()(
   'domain_suffix',
   'example_email',
-  'free_email'
+  'free_email',
+  'emoji'
 );

src/internet.ts

@@ -1,4 +1,4 @@
-import type { Faker } from '.';
+import type { Faker, InternetDefinitions } from '.';
 
 import * as random_ua from './vendor/user-agent';
 
@@ -405,4 +405,25 @@ export class Internet {
     };
     return _password(len, memorable, pattern, prefix);
   }
+
+  /**
+   * Generates a random emoji.
+   *
+   * @param filters A list of the emoji groups that should be used.
+   *
+   * @example
+   * faker.internet.emoji() // '🥰'
+   * faker.internet.emoji(['food', 'nature']) // '🥐'
+   */
+  emoji(filters?: Array<keyof InternetDefinitions['emoji']>): string {
+    filters =
+      filters ||
+      (Object.keys(this.faker.definitions.internet.emoji) as Array<
+        keyof InternetDefinitions['emoji']
+      >);
+    const group = this.faker.random.arrayElement(filters);
+    return this.faker.random.arrayElement(
+      this.faker.definitions.internet.emoji[group]
+    );
+  }
 }

src/locales/en/internet/emoji.ts

@@ -5,12 +5,14 @@
 import type { InternetDefinitions } from '../../..';
 import avatar_uri from './avatar_uri';
 import domain_suffix from './domain_suffix';
+import emoji from './emoji';
 import example_email from './example_email';
 import free_email from './free_email';
 
 const internet = {
   avatar_uri,
   domain_suffix,
+  emoji,
   example_email,
   free_email,
 } as InternetDefinitions;

src/locales/en/internet/index.ts

@@ -7,7 +7,7 @@ import domain_suffix from './domain_suffix';
 import example_email from './example_email';
 import free_email from './free_email';
 
-const internet: InternetDefinitions = {
+const internet: Partial<InternetDefinitions> = {
   domain_suffix,
   example_email,
   free_email,

src/locales/fa/internet/index.ts

@@ -26,6 +26,7 @@ const seededRuns = [
       color: '#30667a',
       mac: '5c:f2:bc:99:27:21',
       password: 'Dl2fkYYKLsZdepz',
+      emoji: '🦟',
     },
   },
   {
@@ -50,6 +51,7 @@ const seededRuns = [
       color: '#214814',
       mac: '48:23:48:70:53:89',
       password: '9V05TL7RY9fmECg',
+      emoji: '💇‍♂️',
     },
   },
   {
@@ -74,6 +76,7 @@ const seededRuns = [
       color: '#773a72',
       mac: 'e7:ec:32:f0:a2:a3',
       password: 'yLuj60b5iHB0bhn',
+      emoji: '🇮🇸',
     },
   },
 ];
@@ -98,6 +101,7 @@ const functionNames = [
   'color',
   'mac',
   'password',
+  'emoji',
 ];
 
 describe('internet', () => {
@@ -546,6 +550,16 @@ describe('internet', () => {
           expect(password).satisfy(validator.isStrongPassword);
         });
       });
+
+      describe('emoji', () => {
+        it('should return a random emoji', () => {
+          const emoji = faker.internet.emoji();
+
+          expect(emoji).toBeTruthy();
+          expect(typeof emoji).toBe('string');
+          expect(emoji.length).toBeGreaterThanOrEqual(1);
+        });
+      });
     }
   });
 });