Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SummaryBuilder

Summary Builder

Build a Summary of a specific section by parsing a line of text that matches the LCOV format.

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

canBuild

  • get canBuild(): boolean

Methods

Protected _convertToInt

  • _convertToInt(s: string): number

  • Helper method to convert a string to a number

    throws

    when input is not a number

    Parameters

    • s: string

      number in a string form to convert

    Returns number

    the parsed number

build

  • Build a Summary

    Use the parsed data to build a Summary. If requisite data has not been provided yet, this method will throw an error.

    throws

    when builder has not received all data yet

    Returns Summary

    Summary containing parsed data

parse

  • parse(line: string): void

  • Parse a line of data

    Parse a line of data that matches the LCOV format. Parsing is only supported for basic summary info, other data will be discarded.

    Invalid input will result in a no-op.

    Parameters

    • line: string

      data to parse

    Returns void

Generated using TypeDoc