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,
        dontRunHook?: boolean,
    ): Promise<null | PreconditionFailure | PropertyFailure>;
    shrink(value: Value<Ts>): Stream<Value<Ts>>;
}

Type Parameters

  • Ts

Hierarchy (View Summary)

Properties

runAfterEach? runBeforeEach?

Methods

afterEach beforeEach generate isAsync run shrink

Properties

OptionalrunAfterEach

runAfterEach?: () => Promise<void>

Run after each hook

Remarks

Since 3.4.0

OptionalrunBeforeEach

runBeforeEach?: () => Promise<void>

Run before each hook

Remarks

Since 3.4.0

Methods

afterEach

beforeEach

generate

isAsync

run

shrink

Settings

Member Visibility

On This Page

Properties
Methods