Interface IAsyncPropertyWithHooks<Ts>

Interface for asynchronous property defining hooks, see IAsyncProperty

Remarks

Since 2.2.0

interface IAsyncPropertyWithHooks<Ts> {
    runAfterEach: () => Promise<void>;
    runBeforeEach: () => Promise<void>;
    afterEach(
        hookFunction: AsyncPropertyHookFunction,
    ): IAsyncPropertyWithHooks<Ts>;
    beforeEach(
        hookFunction: AsyncPropertyHookFunction,
    ): IAsyncPropertyWithHooks<Ts>;
    generate(mrng: Random, runId?: number): Value<Ts>;
    isAsync(): true;
    run(v: Ts): Promise<null | PreconditionFailure | PropertyFailure>;
    shrink(value: Value<Ts>): Stream<Value<Ts>>;
}

Type Parameters

Ts

Hierarchy (View Summary)

IAsyncProperty<Ts>
- IAsyncPropertyWithHooks

Index

Properties

runAfterEach runBeforeEach

Methods

afterEach beforeEach generate isAsync run shrink

Properties

runAfterEach

runAfterEach: () => Promise<void>

Run after each hook

Remarks

Since 3.4.0

runBeforeEach

runBeforeEach: () => Promise<void>

Run before each hook

Remarks

Since 3.4.0

Methods

afterEach

afterEach(hookFunction: AsyncPropertyHookFunction): IAsyncPropertyWithHooks<Ts>
Define a function that should be called after all calls to the predicate
Parameters
- hookFunction: AsyncPropertyHookFunction
  Function to be called
Returns IAsyncPropertyWithHooks<Ts>
Remarks
Since 1.6.0
- Defined in packages/fast-check/src/check/property/AsyncProperty.generic.ts:52

beforeEach

beforeEach(hookFunction: AsyncPropertyHookFunction): IAsyncPropertyWithHooks<Ts>
Define a function that should be called before all calls to the predicate
Parameters
- hookFunction: AsyncPropertyHookFunction
  Function to be called
Returns IAsyncPropertyWithHooks<Ts>
Remarks
Since 1.6.0
- Defined in packages/fast-check/src/check/property/AsyncProperty.generic.ts:45

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 IAsyncProperty.generate
- Defined in packages/fast-check/src/check/property/IRawProperty.ts:49

isAsync

isAsync(): true
Is the property asynchronous?

true in case of asynchronous property, false otherwise

Returns true
Remarks
Since 0.0.7
Inherited from IAsyncProperty.isAsync
- Defined in packages/fast-check/src/check/property/IRawProperty.ts:39

run

run(v: Ts): Promise<null | PreconditionFailure | PropertyFailure>
Check the predicate for v
Parameters
- v: Ts
  Value of which we want to check the predicate
Returns Promise<null | PreconditionFailure | PropertyFailure>
Remarks
Since 0.0.7
Inherited from IAsyncProperty.run
- Defined in packages/fast-check/src/check/property/IRawProperty.ts:65

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 IAsyncProperty.shrink
- Defined in packages/fast-check/src/check/property/IRawProperty.ts:58