import JUnitReporter from '@ls-age/esdoc-coverage/src/lib/JUnitReporter.js'

public class | source

JUnitReporter

Reporter → JUnitReporter

A reporter that creates JUnit-style XML reports.

Constructor Summary

Public Constructor
public	constructor() Creates a new JUnitReporter.

Public Members
public	results: Object[] The results received.

Public Methods
public	finish(): Promise<Error, String> Creates and prints the XML reports.
public	report(filename: string, success: boolean, actual: number, expected: number, uncoveredLines: number[]) Reports the coverage of a file.

From class Reporter
public	actual: number Number of covered identifiers.
public	expected: number Total number of identifiers.
public	notCoveredFiles: number The number of files processed but nut covered.
public	numberOfFiles: number The number of files processed.
public	success: boolean If the report has a failure.
public	finish(): Promise<Error, String> Called once all files have been processed.
public	report(filename: string, success: boolean, actual: number, expected: number, uncoveredLines: number[]) Reports the coverage of a file.

Creates a new JUnitReporter.

The results received.

Creates and prints the XML reports.

Resolved with the report or an error.

Reports the coverage of a file.

Name	Type	Attribute	Description
filename	string		Name of the file.
success	boolean		If the file's documentation coverage meets the threshold.
actual	number		Number of documented identifiers.
expected	number		Number of expected identifiers.
uncoveredLines	number[]		Array of line numbers not documented.