chore: mark mersenne as deprecated (internal) (#1429)

faker-js · Oct 11, 2022 · 7a3136c · 7a3136c
1 parent f921c14
commit 7a3136c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/src/faker.ts b/src/faker.ts
@@ -79,6 +79,9 @@ export class Faker {
   readonly fake: FakeModule['fake'] = new FakeModule(this).fake;
   readonly unique: UniqueModule['unique'] = new UniqueModule(this).unique;
 
+  /**
+   * @deprecated Internal. Use faker.datatype.number() or faker.seed() instead.
+   */
   readonly mersenne: MersenneModule = new MersenneModule();
   readonly random: RandomModule = new RandomModule(this);
 

diff --git a/src/modules/mersenne/index.ts b/src/modules/mersenne/index.ts
@@ -3,6 +3,8 @@ import Gen from './twister';
 
 /**
  * Module to generate seed based random numbers.
+ *
+ * @deprecated Internal. Use faker.datatype.number() or faker.seed() instead.
  */
 export class MersenneModule {
   private gen = new Gen();