Skip to main content

Type Alias: GlobalParameters

GlobalParameters = Pick<Parameters<unknown>, Exclude<keyof Parameters<unknown>, "path" | "examples">> & object

Defined in: packages/fast-check/src/check/runner/configuration/GlobalParameters.ts:25

Type describing the global overrides

Type Declaration​

afterEach?​

optional afterEach?: 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 fast-check#property and fast-check#asyncProperty. This global override should never be used in conjunction with asyncAfterEach.

Remarks​

Since 2.3.0

asyncAfterEach?​

optional asyncAfterEach?: 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 fast-check#asyncProperty. It makes synchronous properties created by fast-check#property unable to run. This global override should never be used in conjunction with afterEach.

Remarks​

Since 2.3.0

asyncBeforeEach?​

optional asyncBeforeEach?: GlobalAsyncPropertyHookFunction

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 fast-check#asyncProperty. It makes synchronous properties created by fast-check#property unable to run. This global override should never be used in conjunction with beforeEach.

Remarks​

Since 2.3.0

baseSize?​

optional baseSize?: Size

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.

Default Value​

"small"

Remarks​

Since 2.22.0

beforeEach?​

optional beforeEach?: GlobalPropertyHookFunction

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 fast-check#property and fast-check#asyncProperty. This global override should never be used in conjunction with asyncBeforeEach.

Remarks​

Since 2.3.0

defaultSizeToMaxWhenMaxSpecified?​

optional defaultSizeToMaxWhenMaxSpecified?: boolean

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

Remarks​

Since 1.18.0