API Reference | fast-check | Property based testing framework
    Preparing search index...

    Interface RunDetailsFailureProperty<Ts>

    Run reported as failed because the property failed

    Refer to RunDetailsCommon for more details

    Since 1.25.0

    interface RunDetailsFailureProperty<Ts> {
        counterexample: Ts;
        counterexamplePath: string;
        errorInstance: unknown;
        executionSummary: ExecutionTree<Ts>[];
        failed: true;
        failures: Ts[];
        interrupted: boolean;
        numRuns: number;
        numShrinks: number;
        numSkips: number;
        runConfiguration: Parameters<Ts>;
        seed: number;
        verbose: VerbosityLevel;
    }

    Type Parameters

    • Ts

    Hierarchy (View Summary)

    Index

    Properties

    counterexample: Ts

    In case of failure: the counterexample contains the minimal failing case (first failure after shrinking)

    Since 0.0.7

    counterexamplePath: string

    In case of failure: path to the counterexample

    For replay purposes, it can be forced in assert, check, sample and statistics using Parameters

    Since 1.0.0

    errorInstance: unknown

    In case of failure: it contains the error that has been thrown if any

    Since 3.0.0

    executionSummary: ExecutionTree<Ts>[]

    Execution summary of the run

    Traces the origin of each value encountered during the test and its execution status. Can help to diagnose shrinking issues.

    You must enable verbose with at least Verbosity.Verbose in Parameters in order to have values in it:

    • Verbose: Only failures
    • VeryVerbose: Failures, Successes and Skipped

    Since 1.9.0

    failed: true

    Does the property failed during the execution of check?

    Since 0.0.7

    failures: Ts[]

    List all failures that have occurred during the run

    You must enable verbose with at least Verbosity.Verbose in Parameters in order to have values in it

    Since 1.1.0

    interrupted: boolean

    Was the execution interrupted?

    Since 1.19.0

    numRuns: number

    Number of runs

    • In case of failed property: Number of runs up to the first failure (including the failure run)
    • Otherwise: Number of successful executions

    Since 1.0.0

    numShrinks: number

    Number of shrinks required to get to the minimal failing case (aka counterexample)

    Since 1.0.0

    numSkips: number

    Number of skipped entries due to failed pre-condition

    As numRuns it only takes into account the skipped values that occured before the first failure. Refer to pre to add such pre-conditions.

    Since 1.3.0

    runConfiguration: Parameters<Ts>

    Configuration of the run

    It includes both local parameters set on check or assert and global ones specified using configureGlobal

    Since 1.25.0

    seed: number

    Seed that have been used by the run

    It can be forced in assert, check, sample and statistics using Parameters

    Since 0.0.7

    Verbosity level required by the user

    Since 1.9.0