diff options
| author | ST-DDT <[email protected]> | 2024-02-27 20:57:27 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-02-27 19:57:27 +0000 |
| commit | 4ab073164beab2bf690d7fffc7773e7b76d8e07e (patch) | |
| tree | 1549dc0aba1646f27edcc00f1651f74a0b5b21fb /docs/guide/randomizer.md | |
| parent | 0d4cba637cdd38e7757ecca1b7eae75d7a737fa8 (diff) | |
| download | faker-4ab073164beab2bf690d7fffc7773e7b76d8e07e.tar.xz faker-4ab073164beab2bf690d7fffc7773e7b76d8e07e.zip | |
feat!: high precision random number generator (#2357)
Diffstat (limited to 'docs/guide/randomizer.md')
| -rw-r--r-- | docs/guide/randomizer.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/guide/randomizer.md b/docs/guide/randomizer.md index e03152a7..16df1209 100644 --- a/docs/guide/randomizer.md +++ b/docs/guide/randomizer.md @@ -12,6 +12,23 @@ There are two connected use cases we have considered where this might be needed: 1. Re-Use of the same `Randomizer` within multiple `Faker` instances. 2. The use of a random number generator from a third party library. +## Built-In `Randomizer`s + +Faker ships with two variations + +```ts +import { + generateMersenne32Randomizer, // Default prior to v9 + generateMersenne53Randomizer, // Default since v9 +} from '@faker-js/faker'; + +const randomizer = generateMersenne53Randomizer(); +``` + +The 32bit `Randomizer` is faster, but the 53bit `Randomizer` generates better random values (with significantly fewer duplicates). + +But you can also implement your own by implementing the [related interface](/api/randomizer.html). + ## Using `Randomizer`s A `Randomizer` has to be set during construction of the instance: |
