fast-check/lib/types/arbitrary/bigUint.d.ts

Property based testing framework for JavaScript (like QuickCheck)

import type { Arbitrary } from '../check/arbitrary/definition/Arbitrary.js';
/**
 * Constraints to be applied on {@link bigUint}
 * @remarks Since 2.6.0
 * @public
 */
export interface BigUintConstraints {
    /**
     * Upper bound for the generated bigints (eg.: 2147483647n, BigInt(Number.MAX_SAFE_INTEGER))
     * @remarks Since 2.6.0
     */
    max?: bigint;
}
/**
 * For positive bigint
 * @deprecated Please use ${@link bigInt} with `fc.bigInt({ min: 0n })` instead
 * @remarks Since 1.9.0
 * @public
 */
declare function bigUint(): Arbitrary<bigint>;
/**
 * For positive bigint between 0 (included) and max (included)
 *
 * @param max - Upper bound for the generated bigint
 * @deprecated Please use ${@link bigInt} with `fc.bigInt({ min: 0n, max })` instead
 * @remarks Since 1.9.0
 * @public
 */
declare function bigUint(max: bigint): Arbitrary<bigint>;
/**
 * For positive bigint between 0 (included) and max (included)
 *
 * @param constraints - Constraints to apply when building instances
 *
 * @deprecated Please use ${@link bigInt} with `fc.bigInt({ min: 0n, max })` instead
 * @remarks Since 2.6.0
 * @public
 */
declare function bigUint(constraints: BigUintConstraints): Arbitrary<bigint>;
export { bigUint };