Interface IPropertyWithHooks<Ts>

Interface for synchronous property defining hooks, see IProperty

Remarks

Since 2.2.0

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

Type Parameters

Hierarchy

IProperty<Ts>
- IPropertyWithHooks

Index

Properties

runAfterEach? runBeforeEach?

Methods

afterEach beforeEach generate isAsync run shrink

Properties

`Optional` runAfterEach

runAfterEach?: (() => void)

Type declaration

- (): void
- Run after each hook
  
  Returns void
  Remarks
  Since 3.4.0

`Optional` runBeforeEach

runBeforeEach?: (() => void)

Type declaration

- (): void
- Run before each hook
  
  Returns void
  Remarks
  Since 3.4.0

Methods

afterEach

afterEach(invalidHookFunction): "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) => Promise<unknown>)
  Function to be called, please provide a valid hook function
  - - (hookFunction): Promise<unknown>
    - Parameters
      hookFunction: GlobalPropertyHookFunction
      Returns Promise<unknown>
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:59
afterEach(hookFunction): 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:67

beforeEach

beforeEach(invalidHookFunction): "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) => Promise<unknown>)
  Function to be called, please provide a valid hook function
  - - (hookFunction): Promise<unknown>
    - Parameters
      hookFunction: GlobalPropertyHookFunction
      Returns Promise<unknown>
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:43
beforeEach(hookFunction): 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:52

generate

generate(mrng, runId?): Value<Ts>
Generate values of type Ts
Parameters
- mrng: Random
  Random number generator
- Optional runId: 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, dontRunHook?): null | PreconditionFailure | PropertyFailure
Check the predicate for v
Parameters
- v: Ts
  Value of which we want to check the predicate
- Optional dontRunHook: 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): 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

Ts

Hierarchy

Index

Properties

Methods

Properties

Optional runAfterEach

Type declaration

Returns void

Remarks

Optional runBeforeEach

Type declaration

Returns void

Remarks

Methods

afterEach

Parameters

invalidHookFunction: ((hookFunction) => Promise<unknown>)

Parameters

hookFunction: GlobalPropertyHookFunction

Returns Promise<unknown>

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

Remarks

Parameters

hookFunction: PropertyHookFunction

Returns IPropertyWithHooks<Ts>

Remarks

beforeEach

Parameters

invalidHookFunction: ((hookFunction) => Promise<unknown>)

Parameters

hookFunction: GlobalPropertyHookFunction

Returns Promise<unknown>

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

Remarks

Parameters

hookFunction: PropertyHookFunction

Returns IPropertyWithHooks<Ts>

Remarks

generate

Parameters

mrng: Random

Optional runId: number

Returns Value<Ts>

Remarks

isAsync

Returns false

Remarks

run

Parameters

v: Ts

Optional dontRunHook: boolean

Returns null | PreconditionFailure | PropertyFailure

Remarks

shrink

Parameters

value: Value<Ts>

Returns Stream<Value<Ts>>

Remarks

Settings

Member Visibility

Theme

On This Page

`Optional` runAfterEach

`Optional` runBeforeEach

`Optional` runId: number

`Optional` dontRunHook: boolean