API Docs for: 0.3.0
Show:

HtmlReport Class

Extends Report
Defined in: lib/report/html.js:309
Module: report

a Report implementation that produces HTML coverage reports.

Usage

 var report = require('istanbul').Report.create('html');

Constructor

HtmlReport

(
  • opts
)

Defined in lib/report/html.js:309

Parameters:

  • opts Object

    optional

    • [dir] String optional

      the directory in which to generate reports. Defaults to ./html-report

Methods

getDefaultConfig

() Object | Null

Inherited from Report: lib/report/index.js:77

returns a config object that has override-able keys settable via config

Returns:

Object | Null:

an object representing keys that can be overridden via the istanbul configuration where the values are the defaults used when not specified. A null return implies no config attributes

synopsis

() String

Inherited from Report: lib/report/index.js:69

returns a one-line summary of the report

Returns:

String:

a description of what the report is about

writeReport

(
  • collector
  • sync
)

Inherited from Report: lib/report/index.js:87

writes the report for a set of coverage objects added to a collector.

Parameters:

  • collector Collector

    the collector for getting the set of files and coverage

  • sync Boolean

    true if reports must be written synchronously, false if they can be written using asynchronous means (e.g. stream.write)