Interface IRawProperty<Ts, IsAsync>

OptionalrunAfterEach

OptionalrunBeforeEach

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)

isAsync

• isAsync(): IsAsync

• Is the property asynchronous?

  true in case of asynchronous property, false otherwise

  Returns IsAsync

  Remarks

  Since 0.0.7

run

• run(
      v: Ts,
      dontRunHook?: boolean,
  ):
      | (
          IsAsync extends true
              ? Promise<null | PreconditionFailure | PropertyFailure>
              : never
      )
      | (
          IsAsync extends false
              ? null
              | PreconditionFailure
              | PropertyFailure
              : never
      )

• 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
      | (
          IsAsync extends true
              ? Promise<null | PreconditionFailure | PropertyFailure>
              : never
      )
      | (
          IsAsync extends false
              ? null
              | PreconditionFailure
              | PropertyFailure
              : never
      )

  Remarks

  Since 0.0.7

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