feat: Add MongoDB ObjectId generation (#616)

faker-js · Apr 6, 2022 · a5b3888 · a5b3888
1 parent 20f33e6
commit a5b3888
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/src/database.ts b/src/database.ts
@@ -59,4 +59,15 @@ export class Database {
       this.faker.definitions.database.engine
     );
   }
+
+  /**
+   * Returns a MongoDB [ObjectId](https://docs.mongodb.com/manual/reference/method/ObjectId/) string.
+   *
+   * @example
+   * faker.database.mongodbObjectId() // 'e175cac316a79afdd0ad3afb'
+   */
+  mongodbObjectId(): string {
+    // strip the "0x" from the hexadecimal output
+    return this.faker.datatype.hexadecimal(24).replace('0x', '').toLowerCase();
+  }
 }
diff --git a/test/database.spec.ts b/test/database.spec.ts
@@ -9,6 +9,7 @@ const seededRuns = [
       type: 'smallint',
       collation: 'utf8_bin',
       engine: 'MEMORY',
+      mongodbObjectId: '8be4abdd39321ad7d3fe01ff',
     },
   },
   {
@@ -18,6 +19,7 @@ const seededRuns = [
       type: 'time',
       collation: 'utf8_general_ci',
       engine: 'MyISAM',
+      mongodbObjectId: '5c346ba075bd57f5a62b82d7',
     },
   },
   {
@@ -27,13 +29,20 @@ const seededRuns = [
       type: 'geometry',
       collation: 'cp1250_general_ci',
       engine: 'ARCHIVE',
+      mongodbObjectId: 'eadb42f0e3f4a973fab0aeef',
     },
   },
 ];
 
 const NON_SEEDED_BASED_RUN = 5;
 
-const functionNames = ['column', 'type', 'collation', 'engine'];
+const functionNames = [
+  'column',
+  'type',
+  'collation',
+  'engine',
+  'mongodbObjectId',
+];
 
 describe('database', () => {
   afterEach(() => {
@@ -95,6 +104,13 @@ describe('database', () => {
           expect(faker.definitions.database.type).toContain(type);
         });
       });
+
+      describe('mongodbObjectId', () => {
+        it('should generate a MongoDB ObjectId value', () => {
+          const generateObjectId = faker.database.mongodbObjectId();
+          expect(generateObjectId).toBeTypeOf('string');
+        });
+      });
     }
   });
 });