import ESDocCoverage from '@ls-age/esdoc-coverage/src/index.js'

public class | source

ESDocCoverage

The main esdoc-coverage class.

Static Member Summary

Static Public Members
public static get	version: string The currently used package version.

Static Public Methods
public static	withArgs(args: string[]): ESDocCoverage Creates a new ESDocCoverage instance with the given command line arguments.

Public Constructor
public	constructor(options: Object, command: string) Creates a new ESDocCoverage instance based on some options and the command to run.

Public Members
public	options: Object The options the current instance was created with.

Private Members
private	_command: string The command to run.

Public Methods
public	checkCoverage(): Promise<Error> Checks the documentation coverage.
public	run(command: Command): Promise<Error> Runs the specified command

Private Methods
private	_checkCoverageReport(report: Object): * Validates the documentation coverage reported in the given report matches the threshold specified.
private	_getCoverageReport(config: Object): Promise<Error, Object> Gets the documentation coverage report for the given config.
private	_getESDocConfig(paths: string[]): Promise<Error, Object> Searches the given paths for valid ESDoc configurations.

The currently used package version.

Creates a new ESDocCoverage instance with the given command line arguments.

Name	Type	Attribute	Description
args	string[]		The command line arguments to use.

The new ESDocCoverage instance.

Creates a new ESDocCoverage instance based on some options and the command to run.

Name	Type	Attribute	Description
options	Object	optional default: {}	The options to use.
options.reporter	string	optional default: 'cli'	The reporter to use.
options.config	string	optional	The esdoc config path.
command	string	optional	The command to run. Note that you have to call ESDocCoverage#run to run the command specified.