docs: expose documentation for randomizers (#3221)

scripts/apidocs/processing/class.ts

@@ -192,7 +192,12 @@ export function processProjectUtilities(project: Project): RawApiDocsPage {
     deprecated: undefined,
     description: 'A list of all the utilities available in Faker.js.',
     examples: [],
-    methods: processProjectFunctions(project, 'mergeLocales'),
+    methods: processProjectFunctions(
+      project,
+      'mergeLocales',
+      'generateMersenne32Randomizer',
+      'generateMersenne53Randomizer'
+    ),
   };
 }
 

src/utils/mersenne.ts

@@ -4,6 +4,17 @@ import type { Randomizer } from '../randomizer';
 /**
  * Generates a MersenneTwister19937 randomizer with 32 bits of precision.
  * This is the default randomizer used by faker prior to v9.0.
+ *
+ * @example
+ * import { de, en, generateMersenne32Randomizer, Faker } from '@faker-js/faker';
+ *
+ * const randomizer = generateMersenne32Randomizer();
+ * randomizer.seed(42);
+ * // Share the same randomizer between multiple instances
+ * const customFaker1 = new Faker({ locale: de, randomizer });
+ * const customFaker2 = new Faker({ locale: en, randomizer });
+ *
+ * @since 8.2.0
  */
 export function generateMersenne32Randomizer(): Randomizer {
   const twister = new MersenneTwister19937();
@@ -27,6 +38,17 @@ export function generateMersenne32Randomizer(): Randomizer {
 /**
  * Generates a MersenneTwister19937 randomizer with 53 bits of precision.
  * This is the default randomizer used by faker starting with v9.0.
+ *
+ * @example
+ * import { de, en, generateMersenne53Randomizer, Faker } from '@faker-js/faker';
+ *
+ * const randomizer = generateMersenne53Randomizer();
+ * randomizer.seed(42);
+ * // Share the same randomizer between multiple instances
+ * const customFaker1 = new Faker({ locale: de, randomizer });
+ * const customFaker2 = new Faker({ locale: en, randomizer });
+ *
+ * @since 9.0.0
  */
 export function generateMersenne53Randomizer(): Randomizer {
   const twister = new MersenneTwister19937();