API Docs for: 0.3.0
Show:

TextReport Class

Extends Report
Defined in: lib/report/text.js:19
Module: report

a Report implementation that produces text output in a detailed table.

Usage

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

Constructor

TextReport

(
  • opts
)

Defined in lib/report/text.js:19

Parameters:

  • opts Object

    optional

    • [dir] String optional

      the directory in which to the text coverage report will be written, when writing to a file

    • [file] String optional

      the filename for the report. When omitted, the report is written to console

    • [maxCols] Number optional

      the max column width of the report. By default, the width of the report is adjusted based on the length of the paths to be reported.

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)