UNPKG

yachr

Version:

Yet another cucumber html reporter

32 lines (31 loc) 1.46 kB
import { FeatureSummary } from './models/aggregator/featureSummary'; import { ScenarioSummary } from './models/aggregator/scenarioSummary'; import { SuiteSummary } from './models/aggregator/suiteSummary'; import { ICucumberFeature } from './models/reporter/cucumberFeature'; import { ICucumberFeatureSuite } from './models/reporter/cucumberFeatureSuite'; import { IScenario } from './models/reporter/scenario'; /** * Aggregates up an array of CucumberResults. * @example * var results: ICucumberResult[] = // Read in Cucumber results json file(s) * const reporter = new ReportAggregator(); * var suiteSummary = reporter.getSummaryForSuite(results); */ export declare class ReportAggregator { /** * Highest level aggregation, takes an array of ICucumberResults and returns * an `ISuiteSummary` * @param suite Array of cucumber results. Standard output from a cucumber test being run. */ getSummaryForSuite(suite: ICucumberFeatureSuite): SuiteSummary; /** * Aggregates a single feature. Aggregates all scenarios in the feature to generate a summary. * @param feature The feature to aggregate */ getSummaryForFeature(feature: ICucumberFeature): FeatureSummary; /** * Aggregates a single scenario. Aggregates the results of all steps in the Scenario to generate a summary. * @param scenario The scenario to aggregate */ getSummaryForScenario(scenario: IScenario): ScenarioSummary; }