API Docs for: 0.3.0
Show:

InstrumentOptions Class

Defined in: lib/config.js:95
Module: config

Object that returns instrumentation options

Constructor

InstrumentOptions

(
  • config
)

Defined in lib/config.js:95

Parameters:

  • config Object

    the instrumentation part of the config object

Methods

baselineFile

() String

Defined in lib/config.js:146

Sets the baseline coverage filename. Used by the instrument command.

Returns:

String:

the name of the baseline coverage file.

compact

() Boolean

Defined in lib/config.js:128

returns if the output should be compact JS. Used by the instrument command.

Returns:

Boolean:

true if the output should be compact

completeCopy

() Boolean

Defined in lib/config.js:111

returns if non-JS files should be copied during instrumentation. Used by the instrument command.

Returns:

Boolean:

true if non-JS files should be copied

defaultExcludes

() Boolean

Defined in lib/config.js:106

returns if default excludes should be turned on. Used by the cover command.

Returns:

Boolean:

true if default excludes should be turned on

embedSource

() Boolean

Defined in lib/config.js:117

returns if the source should be embedded in the instrumented code. Used by the instrument command.

Returns:

Boolean:

true if the source should be embedded in the instrumented code

excludes

() Array

Defined in lib/config.js:166

returns an array of fileset patterns that should be excluded for instrumentation. Used by the instrument and cover commands.

Returns:

Array:

an array of fileset patterns that should be excluded for instrumentation.

preserveComments

() Boolean

Defined in lib/config.js:133

returns if comments should be preserved in the generated JS. Used by the cover and instrument commands.

Returns:

Boolean:

true if comments should be preserved in the generated JS

root

() String

Defined in lib/config.js:159

returns the root directory used by istanbul which is typically the root of the source tree. Used by the cover and report commands.

Returns:

String:

the root directory used by istanbul.

saveBaseline

() Boolean

Defined in lib/config.js:139

returns if a zero-coverage baseline file should be written as part of instrumentation. This allows reporting to display numbers for files that have no tests. Used by the instrument command.

Returns:

Boolean:

true if a baseline coverage file should be written.

variable

() String

Defined in lib/config.js:123

the coverage variable name to use. Used by the instrument command.

Returns:

String:

the coverage variable name to use