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

public class | source

Reporter

Reports per-file documentation coverage.

Constructor Summary

Public Constructor
public	constructor() Creates a new reporter.

Public Members
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 Methods
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 reporter.

Number of covered identifiers.

Total number of identifiers.

The number of files processed but nut covered.

The number of files processed.

If the report has a failure.

Called once all files have been processed. Outputs the report.

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.