BettererSuiteSummary

API > @betterer/betterer > BettererSuiteSummary

The summary of a BettererSuite suite. Includes everything from BettererSuite.

Signature

export interface BettererSuiteSummary extends BettererSuite 

Extends: [BettererSuite](/betterer/docs/betterer.betterersuite)

Remarks

You can get the BettererSuiteSummary via the BettererReporter interface.

Example 1

const myReporter: BettererReporter = {
  // Access the summary after the suite has ended:
  suiteEnd (suiteSummary: BettererSuiteSummary) {
    // ...
  }
}

or by using BettererReporter's Promise-based lifecycle interface:

Example 2

const myReporter: BettererReporter = {
  // Access the summary after the suite has ended:
  suiteStart (suite: BettererSuite, lifecycle: Promise<BettererSuiteSummary>) {
    const summary: BettererSuiteSummary = await lifecycle;
    // ...
  }
}

Properties

Property	Type	Description
better	BettererRunSummaries	An array containing a BettererRunSummary for each test that got better.
changed	BettererTestNames	An array of the names of tests that have changed since they were previously run. This includes tests that were deleted, tests that are new, tests that got better or worse, and tests that stayed the same but still changed in some way.
completed	BettererRunSummaries	An array containing a BettererRunSummary for each test that met its goal.
expired	BettererRunSummaries	An array containing a BettererRunSummary for each test that has expired.
failed	BettererRunSummaries	An array containing a BettererRunSummary for each test that failed.
new	BettererRunSummaries	An array containing a BettererRunSummary for each test that was run for the first time.
ran	BettererRunSummaries	An array containing a BettererRunSummary for each test that didn't fail and wasn't skipped.
runSummaries	BettererRunSummaries	An array containing a BettererRunSummary for each test in the test definition file.
same	BettererRunSummaries	An array containing a BettererRunSummary for each test that stayed the same.
skipped	BettererRunSummaries	An array containing a BettererRunSummary for each test that was skipped.
updated	BettererRunSummaries	An array containing a BettererRunSummary for each test that got worse, but the --update option was enabled.
worse	BettererRunSummaries	An array containing a BettererRunSummary for each test that got worse.