aboutsummaryrefslogtreecommitdiff
path: root/src/faker.ts
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2024-11-12 09:19:28 +0100
committerGitHub <[email protected]>2024-11-12 08:19:28 +0000
commit1633c8deb8f6f41151b39b62689ae3e02ab295bc (patch)
tree2561a719b9154d67c51747a2263f68baf4ff8efa /src/faker.ts
parentcb4b77c04f4d4a706819a6f34ff8378afec6523e (diff)
downloadfaker-1633c8deb8f6f41151b39b62689ae3e02ab295bc.tar.xz
faker-1633c8deb8f6f41151b39b62689ae3e02ab295bc.zip
feat: add initial seed parameter to constructors (#3220)
Diffstat (limited to 'src/faker.ts')
-rw-r--r--src/faker.ts16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/faker.ts b/src/faker.ts
index 77630d29..0b03788b 100644
--- a/src/faker.ts
+++ b/src/faker.ts
@@ -125,6 +125,10 @@ export class Faker extends SimpleFaker {
* Specify this only if you want to use it to achieve a specific goal,
* such as sharing the same random generator with other instances/tools.
* Defaults to faker's Mersenne Twister based pseudo random number generator.
+ * @param options.seed The initial seed to use.
+ * The seed can be used to generate reproducible values.
+ * Refer to the `seed()` method for more information.
+ * Defaults to a random seed.
*
* @example
* import { Faker, es } from '@faker-js/faker';
@@ -157,8 +161,18 @@ export class Faker extends SimpleFaker {
* @default generateMersenne53Randomizer()
*/
randomizer?: Randomizer;
+
+ /**
+ * The initial seed to use.
+ * The seed can be used to generate reproducible values.
+ *
+ * Refer to the `seed()` method for more information.
+ *
+ * Defaults to a random seed.
+ */
+ seed?: number;
}) {
- super({ randomizer: options.randomizer });
+ super({ randomizer: options.randomizer, seed: options.seed });
let { locale } = options;