feat(helpers): new method enumValue

src/modules/datatype/index.ts

@@ -84,6 +84,34 @@ export class DatatypeModule {
     return this.faker.number.float({ min, max, precision });
   }
 
+  /**
+   * Returns a random value from an Enum object
+   *
+   * @param enumObject
+   *
+   * @example
+   * faker.datatype.enum(enum { A, B, C}) // 'C'
+   * faker.datatype.enum(enum { A, B, C}) // 'A'
+   * faker.datatype.enum(enum { A, B, C}) // 'B'
+   */
+  enum<GenericEnumType extends Object, SpecificEnumType>(
+    enumObject: GenericEnumType
+  ): SpecificEnumType {
+    if(!enumObject) return '0' as SpecificEnumType
+    const ignoreTypeScriptAddedKeys = (enumKeys: string[]) => {
+      return enumKeys.filter((key) => isNaN(Number(key)));
+    };
+    const keys = Object.keys(enumObject);
+    const enumKeys = ignoreTypeScriptAddedKeys(keys);
+    const { length } = enumKeys;
+    const validIndexes = length - 1;
+    const randomEnumIndex = this.faker.number.int(validIndexes);
+    const randomOption = (enumObject as any)[
+      randomEnumIndex
+    ] as SpecificEnumType;
+    return randomOption;
+  }
+
   /**
    * Returns a single random floating-point number for the given precision or range and precision.
    *

test/__snapshots__/datatype.spec.ts.snap

@@ -61,6 +61,14 @@ exports[`datatype > 42 > datetime > with min 1`] = `1801-04-11T15:13:06.330Z`;
 
 exports[`datatype > 42 > datetime > with min and max 1`] = `1689-09-09T08:39:09.444Z`;
 
+exports[`datatype > 42 > enum > with default enum 1`] = `"B"`;
+
+exports[`datatype > 42 > enum > with enum starting from some index 1`] = `undefined`;
+
+exports[`datatype > 42 > enum > with string enum 1`] = `undefined`;
+
+exports[`datatype > 42 > enum > with valid enum 1`] = `"B"`;
+
 exports[`datatype > 42 > float > noArgs 1`] = `37453.64`;
 
 exports[`datatype > 42 > float > repeated 1`] = `37453.64`;
@@ -193,6 +201,14 @@ exports[`datatype > 1211 > datetime > with min 1`] = `2065-11-10T19:27:20.915Z`;
 
 exports[`datatype > 1211 > datetime > with min and max 1`] = `1789-03-26T15:44:45.219Z`;
 
+exports[`datatype > 1211 > enum > with default enum 1`] = `"C"`;
+
+exports[`datatype > 1211 > enum > with enum starting from some index 1`] = `"A"`;
+
+exports[`datatype > 1211 > enum > with string enum 1`] = `undefined`;
+
+exports[`datatype > 1211 > enum > with valid enum 1`] = `"C"`;
+
 exports[`datatype > 1211 > float > noArgs 1`] = `92851.09`;
 
 exports[`datatype > 1211 > float > repeated 1`] = `92851.09`;
@@ -323,6 +339,14 @@ exports[`datatype > 1337 > datetime > with min 1`] = `1747-07-16T01:19:54.159Z`;
 
 exports[`datatype > 1337 > datetime > with min and max 1`] = `1669-06-22T01:21:21.236Z`;
 
+exports[`datatype > 1337 > enum > with default enum 1`] = `"A"`;
+
+exports[`datatype > 1337 > enum > with enum starting from some index 1`] = `undefined`;
+
+exports[`datatype > 1337 > enum > with string enum 1`] = `undefined`;
+
+exports[`datatype > 1337 > enum > with valid enum 1`] = `"A"`;
+
 exports[`datatype > 1337 > float > noArgs 1`] = `26202.2`;
 
 exports[`datatype > 1337 > float > repeated 1`] = `26202.2`;

test/datatype.spec.ts

@@ -50,6 +50,29 @@ describe('datatype', () => {
         });
     });
 
+    t.describe('enum', (t) => {
+      enum defaultEnum {
+        A,
+        B,
+        C,
+      }
+
+      enum enumStartingFromSomeInt {
+        A = 2,
+        B,
+        C,
+      }
+
+      enum stringEnum {
+        A = 'A',
+        B = 'B',
+        C = 'C',
+      }
+      t.it('with default enum', defaultEnum)
+        .it('with enum starting from some index', enumStartingFromSomeInt)
+        .it('with string enum', stringEnum);
+    });
+
     t.describe('string', (t) => {
       t.it('noArgs')
         .it('with number', 42)