Skip to main content

Class: Random

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

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

Constructors

Constructor

new Random(sourceRng): Random

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

Create a mutable random number generator by cloning the passed one and mutate it

Parameters

ParameterTypeDescription
sourceRnganyImmutable random generator from pure-rand library, will not be altered (a clone will be)

Returns

Random

Methods

clone()

clone(): Random

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

Clone the random number generator

Returns

Random


getState()

getState(): readonly number[] | undefined

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

Extract the internal state of the internal RandomGenerator backing the current instance of Random

Returns

readonly number[] | undefined


next()

next(bits): number

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

Generate an integer having bits random bits

Parameters

ParameterTypeDescription
bitsnumberNumber of bits to generate

Returns

number

Deprecated

Prefer nextInt with explicit bounds: nextInt(0, (1 << bits) - 1)


nextBigInt()

nextBigInt(min, max): bigint

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

Generate a random bigint between min (included) and max (included)

Parameters

ParameterTypeDescription
minbigintMinimal bigint value
maxbigintMaximal bigint value

Returns

bigint


nextBoolean()

nextBoolean(): boolean

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

Generate a random boolean

Returns

boolean


nextDouble()

nextDouble(): number

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

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

Returns

number


nextInt()

Call Signature

nextInt(): number

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

Generate a random integer (32 bits)

Returns

number

Deprecated

Prefer nextInt with explicit bounds: nextInt(-2147483648, 2147483647)

Call Signature

nextInt(min, max): number

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

Generate a random integer between min (included) and max (included)

Parameters
ParameterTypeDescription
minnumberMinimal integer value
maxnumberMaximal integer value
Returns

number