Skip to main content

Function: bigInt()

Call Signature

bigInt(): Arbitrary<bigint>

Defined in: packages/fast-check/src/arbitrary/bigInt.ts:64

For bigint

Returns

Arbitrary<bigint>

Remarks

Since 1.9.0

Call Signature

bigInt(min, max): Arbitrary<bigint>

Defined in: packages/fast-check/src/arbitrary/bigInt.ts:74

For bigint between min (included) and max (included)

Parameters

ParameterTypeDescription
minbigintLower bound for the generated bigints (eg.: -5n, 0n, BigInt(Number.MIN_SAFE_INTEGER))
maxbigintUpper bound for the generated bigints (eg.: -2n, 2147483647n, BigInt(Number.MAX_SAFE_INTEGER))

Returns

Arbitrary<bigint>

Remarks

Since 1.9.0

Call Signature

bigInt(constraints): Arbitrary<bigint>

Defined in: packages/fast-check/src/arbitrary/bigInt.ts:83

For bigint between min (included) and max (included)

Parameters

ParameterTypeDescription
constraintsBigIntConstraintsConstraints to apply when building instances

Returns

Arbitrary<bigint>

Remarks

Since 2.6.0

Call Signature

bigInt(...args): Arbitrary<bigint>

Defined in: packages/fast-check/src/arbitrary/bigInt.ts:92

For bigint between min (included) and max (included)

Parameters

ParameterTypeDescription
...args[] | [bigint, bigint] | [BigIntConstraints]Either min/max bounds as an object or constraints to apply when building instances

Returns

Arbitrary<bigint>

Remarks

Since 2.6.0