Class Random

Wrapper around an instance of a pure-rand's random number generator offering a simpler interface to deal with random with impure patterns

Index

Constructors

Methods

clone getState next nextArrayInt nextBigInt nextBoolean nextDouble nextInt

Constructors

constructor

new Random(sourceRng: RandomGenerator): Random
Create a mutable random number generator by cloning the passed one and mutate it
Parameters
- sourceRng: RandomGenerator
  Immutable random generator from pure-rand library, will not be altered (a clone will be)
Returns Random
- Defined in packages/fast-check/src/random/generator/Random.ts:27

Methods

clone

clone(): Random
Clone the random number generator

Returns Random
- Defined in packages/fast-check/src/random/generator/Random.ts:34

getState

getState(): undefined | readonly number[]
Extract the internal state of the internal RandomGenerator backing the current instance of Random

Returns undefined | readonly number[]
- Defined in packages/fast-check/src/random/generator/Random.ts:106

next

next(bits: number): number
Generate an integer having bits random bits
Parameters
- bits: number
  Number of bits to generate
Returns number
- Defined in packages/fast-check/src/random/generator/Random.ts:42

nextArrayInt

nextArrayInt(
min: { data: number[]; sign: -1 | 1 },
max: { data: number[]; sign: -1 | 1 },
): { data: number[]; sign: -1 | 1 }
Generate a random ArrayInt between min (included) and max (included)
Parameters
- min: { data: number[]; sign: -1 | 1 }
  Minimal ArrayInt value
- max: { data: number[]; sign: -1 | 1 }
  Maximal ArrayInt value
Returns { data: number[]; sign: -1 | 1 }
- Defined in packages/fast-check/src/random/generator/Random.ts:87

nextBigInt

nextBigInt(min: bigint, max: bigint): bigint
Generate a random bigint between min (included) and max (included)
Parameters
- min: bigint
  Minimal bigint value
- max: bigint
  Maximal bigint value
Returns bigint
- Defined in packages/fast-check/src/random/generator/Random.ts:78

nextBoolean

nextBoolean(): boolean
Generate a random boolean

Returns boolean
- Defined in packages/fast-check/src/random/generator/Random.ts:50

nextDouble

nextDouble(): number
Generate a random floating point number between 0.0 (included) and 1.0 (excluded)

Returns number
- Defined in packages/fast-check/src/random/generator/Random.ts:97

nextInt

nextInt(): number
Generate a random integer (32 bits)

Returns number
- Defined in packages/fast-check/src/random/generator/Random.ts:57
nextInt(min: number, max: number): number
Generate a random integer between min (included) and max (included)
Parameters
- min: number
  Minimal integer value
- max: number
  Maximal integer value
Returns number
- Defined in packages/fast-check/src/random/generator/Random.ts:64