• Format output of check using the default error reporting of assert

    Produce a string containing the formated error in case of failed run, undefined otherwise.

    Type Parameters

    • Ts

    Parameters

    • out: {
          counterexample: null;
          counterexamplePath: null;
          error: null;
          errorInstance: null;
          executionSummary: ExecutionTree<Ts>[];
          failed: false;
          failures: Ts[];
          interrupted: boolean;
          numRuns: number;
          numShrinks: number;
          numSkips: number;
          runConfiguration: Parameters<Ts>;
          seed: number;
          verbose: VerbosityLevel;
      }
      • counterexample: null
      • counterexamplePath: null
      • error: null
      • errorInstance: null
      • 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

        Remarks

        Since 1.9.0

      • failed: false
      • 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

        Remarks

        Since 1.1.0

      • interrupted: boolean
      • 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

        Remarks

        Since 1.0.0

      • numShrinks: number

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

        Remarks

        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.

        Remarks

        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

        Remarks

        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

        Remarks

        Since 0.0.7

      • verbose: VerbosityLevel

        Verbosity level required by the user

        Remarks

        Since 1.9.0

    Returns Promise<undefined>

    Remarks

    Since 2.17.0

  • Format output of check using the default error reporting of assert

    Produce a string containing the formated error in case of failed run, undefined otherwise.

    Type Parameters

    • Ts

    Parameters

    Returns Promise<string>

    Remarks

    Since 2.17.0

  • Format output of check using the default error reporting of assert

    Produce a string containing the formated error in case of failed run, undefined otherwise.

    Type Parameters

    • Ts

    Parameters

    Returns Promise<string | undefined>

    Remarks

    Since 2.17.0

Generated using TypeDoc