Class FlatReportBuilder

Flat Report Builder

An extension of {@link ReportBuilder | ReportBuilder} that builds a FlatReport instead of a regular Report.

Hierarchy

ReportBuilder
- FlatReportBuilder

Index

Constructors

constructor

Methods

Constructors

constructor

new FlatReportBuilder(rootDirectory?: string): FlatReportBuilder

Overrides ReportBuilder.constructor
- Defined in classes/builders/flatReportBuilder.ts:26
Construct a ReportBuilder

Parameters
- Default value rootDirectory: string = ""
  
  base path that the incoming file path should be relativized with
Returns FlatReportBuilder

Methods

build

build(): FlatReport

Overrides ReportBuilder.build
- Defined in classes/builders/flatReportBuilder.ts:50
Build a FlatReport

Use the parsed data to build a FlatReport. If at least on section of data has not been parsed yet, this method will throw an error.

throws

when builder has not received at least one section of data

Returns FlatReport

FlatReport containing parsed data

Protected getDetailSummaryBuilder

getDetailSummaryBuilder(rootDirectory?: undefined | string): DetailedSummaryBuilder

Overrides ReportBuilder.getDetailSummaryBuilder
- Defined in classes/builders/flatReportBuilder.ts:68
Build a new DetailedSummaryBuilder for a detail section

Parameters
- Optional rootDirectory: undefined | string
  
  option to pass to DetailedSummaryBuilder constructor
Returns DetailedSummaryBuilder

DetailedSummaryBuilder

Protected handleParseDetail

handleParseDetail(line: string): void

Inherited from ReportBuilder.handleParseDetail
- Defined in classes/builders/reportBuilder.ts:151
Handle parsing data for current section

remarks

When the section has enough data, the Summary is built and a new SummaryBuilder is created to handle parsing the next section. If a Summary already exists for the given path, the new Summary is combined with the existing Summary.

Parameters
- line: string
  
  data to parse
Returns void

Protected handleParseTotal

handleParseTotal(line: string): void

Inherited from ReportBuilder.handleParseTotal
- Defined in classes/builders/reportBuilder.ts:121
Handle parsing data for total summary

Parameters
- line: string
  
  data to parse
Returns void

parse

parse(line: string): void

Inherited from ReportBuilder.parse
- Defined in classes/builders/reportBuilder.ts:95
Parse a line of data

Parse a line of data that matches the LCOV format. Data will contribute to both the section's summary data as well as total summary data for the report.

Parameters
- line: string
  
  data to parse
Returns void

Generated using TypeDoc