Interface IPropertyWithHooks<Ts>

Interface for synchronous property defining hooks, see IProperty

Remarks

Since 2.2.0

interface IPropertyWithHooks<Ts> {
    runAfterEach?: () => void;
    runBeforeEach?: () => void;
    afterEach(
        invalidHookFunction: (
            hookFunction: GlobalPropertyHookFunction,
        ) => Promise<unknown>,
    ): "afterEach expects a synchronous function but was given a function returning a Promise";
    afterEach(hookFunction: PropertyHookFunction): IPropertyWithHooks<Ts>;
    beforeEach(
        invalidHookFunction: (
            hookFunction: GlobalPropertyHookFunction,
        ) => Promise<unknown>,
    ): "beforeEach expects a synchronous function but was given a function returning a Promise";
    beforeEach(hookFunction: PropertyHookFunction): IPropertyWithHooks<Ts>;
    generate(mrng: Random, runId?: number): Value<Ts>;
    isAsync(): false;
    run(
        v: Ts,
        dontRunHook?: boolean,
    ): null | PreconditionFailure | PropertyFailure;
    shrink(value: Value<Ts>): Stream<Value<Ts>>;
}

Type Parameters

Hierarchy (View Summary)

IProperty<Ts>
- IPropertyWithHooks

Index

Properties

runAfterEach? runBeforeEach?

Methods

afterEach beforeEach generate isAsync run shrink

Properties

`Optional`runAfterEach

runAfterEach?: () => void

Run after each hook

Remarks

Since 3.4.0

`Optional`runBeforeEach

runBeforeEach?: () => void

Run before each hook

Remarks

Since 3.4.0

Methods

afterEach

afterEach(
    invalidHookFunction: (
        hookFunction: GlobalPropertyHookFunction,
    ) => Promise<unknown>,
): "afterEach expects a synchronous function but was given a function returning a Promise"
Define a function that should be called after all calls to the predicate
Parameters
- invalidHookFunction: (hookFunction: GlobalPropertyHookFunction) => Promise<unknown>
  Function to be called, please provide a valid hook function
Returns "afterEach expects a synchronous function but was given a function returning a Promise"
Remarks
Since 1.6.0
- Defined in packages/fast-check/src/check/property/Property.generic.ts:60
afterEach(hookFunction: PropertyHookFunction): IPropertyWithHooks<Ts>
Define a function that should be called after all calls to the predicate
Parameters
- hookFunction: PropertyHookFunction
  Function to be called
Returns IPropertyWithHooks<Ts>
Remarks
Since 1.6.0
- Defined in packages/fast-check/src/check/property/Property.generic.ts:68

beforeEach

beforeEach(
    invalidHookFunction: (
        hookFunction: GlobalPropertyHookFunction,
    ) => Promise<unknown>,
): "beforeEach expects a synchronous function but was given a function returning a Promise"
Define a function that should be called before all calls to the predicate
Parameters
- invalidHookFunction: (hookFunction: GlobalPropertyHookFunction) => Promise<unknown>
  Function to be called, please provide a valid hook function
Returns "beforeEach expects a synchronous function but was given a function returning a Promise"
Remarks
Since 1.6.0
- Defined in packages/fast-check/src/check/property/Property.generic.ts:44
beforeEach(hookFunction: PropertyHookFunction): IPropertyWithHooks<Ts>
Define a function that should be called before all calls to the predicate
Parameters
- hookFunction: PropertyHookFunction
  Function to be called
Returns IPropertyWithHooks<Ts>
Remarks
Since 1.6.0
- Defined in packages/fast-check/src/check/property/Property.generic.ts:53

generate

generate(mrng: Random, runId?: number): Value<Ts>
Generate values of type Ts
Parameters
- mrng: Random
  Random number generator
- OptionalrunId: number
  Id of the generation, starting at 0 - if set the generation might be biased
Returns Value<Ts>
Remarks
Since 0.0.7 (return type changed in 3.0.0)
Inherited from IProperty.generate
- Defined in packages/fast-check/src/check/property/IRawProperty.ts:54

isAsync

isAsync(): false
Is the property asynchronous?

true in case of asynchronous property, false otherwise

Returns false
Remarks
Since 0.0.7
Inherited from IProperty.isAsync
- Defined in packages/fast-check/src/check/property/IRawProperty.ts:44

run

run(v: Ts, dontRunHook?: boolean): null | PreconditionFailure | PropertyFailure
Check the predicate for v
Parameters
- v: Ts
  Value of which we want to check the predicate
- OptionaldontRunHook: boolean
  Do not run beforeEach and afterEach hooks within run
Returns null | PreconditionFailure | PropertyFailure
Remarks
Since 0.0.7
Inherited from IProperty.run
- Defined in packages/fast-check/src/check/property/IRawProperty.ts:71

shrink

shrink(value: Value<Ts>): Stream<Value<Ts>>
Shrink value of type Ts
Parameters
- value: Value<Ts>
  The value to be shrunk, it can be context-less
Returns Stream<Value<Ts>>
Remarks
Since 3.0.0
Inherited from IProperty.shrink
- Defined in packages/fast-check/src/check/property/IRawProperty.ts:63

Interface IPropertyWithHooks<Ts>

Remarks

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

OptionalrunAfterEach

Remarks

OptionalrunBeforeEach

Remarks

Methods

afterEach

Parameters

Returns "afterEach expects a synchronous function but was given a function returning a Promise"

Remarks

Parameters

Returns IPropertyWithHooks<Ts>

Remarks

beforeEach

Parameters

Returns "beforeEach expects a synchronous function but was given a function returning a Promise"

Remarks

Parameters

Returns IPropertyWithHooks<Ts>

Remarks

generate

Parameters

Returns Value<Ts>

Remarks

isAsync

Returns false

Remarks

run

Parameters

Returns null | PreconditionFailure | PropertyFailure

Remarks

shrink

Parameters

Returns Stream<Value<Ts>>

Remarks

Settings

On This Page

`Optional`runAfterEach

`Optional`runBeforeEach