Interface IProperty<Ts>

Optional runAfterEach

Optional runBeforeEach

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)

isAsync

• isAsync(): false

• Is the property asynchronous?

  true in case of asynchronous property, false otherwise

  Returns false

  Remarks

  Since 0.0.7

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

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