fast-check/lib/types/check/runner/configuration/GlobalParameters.d.ts

Property based testing framework for JavaScript (like QuickCheck)

import type { Size } from '../../../arbitrary/_internals/helpers/MaxLengthFromMinLength.js';
import type { Parameters } from './Parameters.js';
/**
 * Type of legal hook function that can be used in the global parameter `beforeEach` and/or `afterEach`
 * @remarks Since 2.3.0
 * @public
 */
export type GlobalPropertyHookFunction = () => void;
/**
 * Type of legal hook function that can be used in the global parameter `asyncBeforeEach` and/or `asyncAfterEach`
 * @remarks Since 2.3.0
 * @public
 */
export type GlobalAsyncPropertyHookFunction = (() => Promise<unknown>) | (() => void);
/**
 * Type describing the global overrides
 * @remarks Since 1.18.0
 * @public
 */
export type GlobalParameters = Pick<Parameters<unknown>, Exclude<keyof Parameters<unknown>, 'path' | 'examples'>> & {
    /**
     * Specify a function that will be called before each execution of a property.
     * It behaves as-if you manually called `beforeEach` method on all the properties you execute with fast-check.
     *
     * The function will be used for both {@link fast-check#property} and {@link fast-check#asyncProperty}.
     * This global override should never be used in conjunction with `asyncBeforeEach`.
     *
     * @remarks Since 2.3.0
     */
    beforeEach?: GlobalPropertyHookFunction;
    /**
     * Specify a function that will be called after each execution of a property.
     * It behaves as-if you manually called `afterEach` method on all the properties you execute with fast-check.
     *
     * The function will be used for both {@link fast-check#property} and {@link fast-check#asyncProperty}.
     * This global override should never be used in conjunction with `asyncAfterEach`.
     *
     * @remarks Since 2.3.0
     */
    afterEach?: GlobalPropertyHookFunction;
    /**
     * Specify a function that will be called before each execution of an asynchronous property.
     * It behaves as-if you manually called `beforeEach` method on all the asynchronous properties you execute with fast-check.
     *
     * The function will be used only for {@link fast-check#asyncProperty}. It makes synchronous properties created by {@link fast-check#property} unable to run.
     * This global override should never be used in conjunction with `beforeEach`.
     *
     * @remarks Since 2.3.0
     */
    asyncBeforeEach?: GlobalAsyncPropertyHookFunction;
    /**
     * Specify a function that will be called after each execution of an asynchronous property.
     * It behaves as-if you manually called `afterEach` method on all the asynchronous properties you execute with fast-check.
     *
     * The function will be used only for {@link fast-check#asyncProperty}. It makes synchronous properties created by {@link fast-check#property} unable to run.
     * This global override should never be used in conjunction with `afterEach`.
     *
     * @remarks Since 2.3.0
     */
    asyncAfterEach?: GlobalAsyncPropertyHookFunction;
    /**
     * Define the base size to be used by arbitraries.
     *
     * By default arbitraries not specifying any size will default to it (except in some cases when used defaultSizeToMaxWhenMaxSpecified is true).
     * For some arbitraries users will want to override the default and either define another size relative to this one,
     * or a fixed one.
     *
     * @defaultValue `"small"`
     * @remarks Since 2.22.0
     */
    baseSize?: Size;
    /**
     * When set to `true` and if the size has not been defined for this precise instance,
     * it will automatically default to `"max"` if the user specified a upper bound for the range
     * (applies to length and to depth).
     *
     * When `false`, the size will be defaulted to `baseSize` even if the user specified
     * a upper bound for the range.
     *
     * @remarks Since 2.22.0
     */
    defaultSizeToMaxWhenMaxSpecified?: boolean;
};
/**
 * Define global parameters that will be used by all the runners
 *
 * @example
 * ```typescript
 * fc.configureGlobal({ numRuns: 10 });
 * //...
 * fc.assert(
 *   fc.property(
 *     fc.nat(), fc.nat(),
 *     (a, b) => a + b === b + a
 *   ), { seed: 42 }
 * ) // equivalent to { numRuns: 10, seed: 42 }
 * ```
 *
 * @param parameters - Global parameters
 *
 * @remarks Since 1.18.0
 * @public
 */
export declare function configureGlobal(parameters: GlobalParameters): void;
/**
 * Read global parameters that will be used by runners
 * @remarks Since 1.18.0
 * @public
 */
export declare function readConfigureGlobal(): GlobalParameters;
/**
 * Reset global parameters
 * @remarks Since 1.18.0
 * @public
 */
export declare function resetConfigureGlobal(): void;