ReportingOptions Class
Object that returns reporting options
Constructor
ReportingOptions
-
config
Parameters:
-
configObjectthe reporting part of the config object
Item Index
Methods
Methods
dir
()
String
returns the directory under which reports should be generated. Used by the
cover and report commands.
Returns:
the directory under which reports should be generated.
print
()
String
returns the kind of information to be printed on the console. May be one
of summary, detail, both or none. Used by the
cover command.
Returns:
the kind of information to print to the console at the end
of the cover command execution.
reportConfig
()
Object
returns an object that has keys that are report format names and values that are objects
containing detailed configuration for each format. Running istanbul help config
will give you all the keys per report format that can be overridden.
Used by the cover and report commands.
Returns:
detailed report configuration per report format.
reports
()
Array
returns a list of reports that should be generated at the end of a run. Used
by the cover and report commands.
Returns:
an array of reports that should be produced
watermarks
()
Object
returns the low and high watermarks to be used to designate whether coverage
is low, medium or high. Statements, functions, branches and lines can
have independent watermarks. These are respected by all reports
that color for low, medium and high coverage. See the default configuration for exact syntax
using istanbul help config. Used by the cover and report commands.
Returns:
an object containing low and high watermarks for statements, branches, functions and lines.