Class RandomNumberGeneratorFactory

A static factory class for creating a SeededRandomNumberGenerator object.

Since

0.1.0

Index

Methods

asyncBuild build

Methods

`Static`asyncBuild

asyncBuild(
seed: string,
namespace?: string,
): Promise<SeededRandomNumberGenerator>
Build a SeededRandomNumberGenerator object with the given seed and namespace from an asynchronous hashing algorithm.
Parameters
- seed: string
  The primary input to determine the random number sequence.
- Optionalnamespace: string
  Namespace to create different sequences from the same seed.
Returns Promise<SeededRandomNumberGenerator>
Remarks
This method relies on the Web Crypto API via crypto.subtle. In Node.js environments, ensure you are using a version where the Web Crypto API is available.
Throws
- When the given seed is not a string.
Throws
- When the given namespace is not a string.
Since
0.1.0
- Defined in random/seeded-random/random-number-generator-factory.ts:105

`Static`build

build(
    seed: string,
    namespace?: string,
    version?: number,
): SeededRandomNumberGenerator
Build a SeededRandomNumberGenerator object with the given seed, namespace, and version.
Parameters
- seed: string
  The primary input to determine the random number sequence.
- Optionalnamespace: string
  Namespace to create different sequences from the same seed.
- Optionalversion: number
  The SeedVersions index to use for selecting the offsets for hashing. Changing the version number will result in a different sequence of random numbers for the same seed and namespace.
Returns SeededRandomNumberGenerator
See
- SeedVersions.size
- SeedVersions.isValidIndex
Throws
- When the given seed is not a string.
Throws
- When the given namespace is not a string.
Throws
- When the given version is not an integer.
Throws
- When the given version is not a valid SeedVersions index.
Since
0.1.0
- Defined in random/seeded-random/random-number-generator-factory.ts:81