Interface IRawProperty<Ts, IsAsync>

Property

A property is the combination of:

  • Arbitraries: how to generate the inputs for the algorithm
  • Predicate: how to confirm the algorithm succeeded?

Remarks

Since 1.19.0

interface IRawProperty<Ts, IsAsync> {
    runAfterEach?: (() => (IsAsync extends true
        ? Promise<void>
        : never) | (IsAsync extends false
        ? void
        : never));
    runBeforeEach?: (() => (IsAsync extends true
        ? Promise<void>
        : never) | (IsAsync extends false
        ? void
        : never));
    generate(mrng, runId?): Value<Ts>;
    isAsync(): IsAsync;
    run(v, dontRunHook?): (IsAsync extends true
        ? Promise<null | PreconditionFailure | PropertyFailure>
        : never) | (IsAsync extends false
        ? null | PreconditionFailure | PropertyFailure
        : never);
    shrink(value): Stream<Value<Ts>>;
}

Type Parameters

  • Ts
  • IsAsync extends boolean = boolean

Hierarchy (view full)

Properties

runAfterEach? runBeforeEach?

Methods

generate isAsync run shrink

Properties

Optional runAfterEach

runAfterEach?: (() => (IsAsync extends true
    ? Promise<void>
    : never) | (IsAsync extends false
    ? void
    : never))

Run after each hook

Type declaration

    • (): (IsAsync extends true
          ? Promise<void>
          : never) | (IsAsync extends false
          ? void
          : never)

    • Returns (IsAsync extends true
          ? Promise<void>
          : never) | (IsAsync extends false
          ? void
          : never)

Remarks

Since 3.4.0

Optional runBeforeEach

runBeforeEach?: (() => (IsAsync extends true
    ? Promise<void>
    : never) | (IsAsync extends false
    ? void
    : never))

Run before each hook

Type declaration

    • (): (IsAsync extends true
          ? Promise<void>
          : never) | (IsAsync extends false
          ? void
          : never)

    • Returns (IsAsync extends true
          ? Promise<void>
          : never) | (IsAsync extends false
          ? void
          : never)

Remarks

Since 3.4.0

Methods

generate

isAsync

run

shrink

Settings

Member Visibility

Theme

On This Page

runAfterEachrunBeforeEachgenerateisAsyncrunshrink