Class Summarizer<Output, Configuration>`Abstract`

Type Parameters

Output
Configuration extends CommonSummarizerConfiguration

Hierarchy (View Summary)

Summarizer
- BenchmarkSummarizer
- StatisticsSummarizer

Hierarchy-Diagram

UML class diagram of Summarizer

Index

Constructors

Properties

Methods

preparationPhase summarizePhase

Constructors

`Protected`constructor

new Summarizer<Output, Configuration extends CommonSummarizerConfiguration>(
config: Configuration,
): Summarizer<Output, Configuration>
Type Parameters
- Output
- Configuration extends CommonSummarizerConfiguration
Parameters
- config: Configuration
Returns Summarizer<Output, Configuration>
- Defined in src/util/summarizer.ts:29

Properties

`Protected` `Readonly`config

config: Configuration

`Protected` `Readonly`log

log: (message: string) => void

Methods

`Abstract`preparationPhase

preparationPhase(useTypeClassification: boolean): Promise<void>
First phase of the summary, can be used to extract all data of interest from the individual benchmark or statistic results. This can write temporary files based on the configuration.
Parameters
- useTypeClassification: boolean
  Whether to split the analysis based on the detected type (e.g. 'test', 'example', ...)
Returns Promise<void>
- Defined in src/util/summarizer.ts:39

`Abstract`summarizePhase

summarizePhase(): Promise<Output>
Second phase of the summary, can be used to combine the data from the first phase and produce some kind of "ultimate results".

Returns Promise<Output>
- Defined in src/util/summarizer.ts:45