API Docs for: 0.9.3
Show:

MochaTask Class

Extends AbstractForkTask
Defined in: lib/task/mocha.js:9

Constructor

MochaTask

()

Defined in lib/task/mocha.js:9

Methods

_run

(
  • parentId
)
Promise private

Inherited from AbstractTask but overwritten in lib/task/mocha.js:338

Run the client

Parameters:

Returns:

Promise:

augment

()

Inherited from AbstractTask: lib/abstractTask.js:113

Augments the data with default values

getClientDecoratorPlugins

() Object[]

Inherited from AbstractTask: lib/abstractTask.js:304

Gets all client-decorator plugins

Returns:

Object[]:

getConfiguration

() Object

Inherited from AbstractTask: lib/abstractTask.js:133

Gets the client configuration

Returns:

Object:

getCoverageCollector

() Collector

Inherited from AbstractTask: lib/abstractTask.js:163

Gets the coverage collector

Returns:

Collector:

getDecorators

() Object[]

Inherited from AbstractTask: lib/abstractTask.js:143

Gets the decorator list

Returns:

Object[]:

getFunctions

() Function[]

Defined in lib/task/mocha.js:293

Gets a list of functions to execute before the tests Mocha Option:

Returns:

Function[]:

getGlobalConfig

() Object

Inherited from AbstractTask: lib/abstractTask.js:153

Gets the global configuration

Returns:

Object:

getGlobals

() String[]

Defined in lib/task/mocha.js:271

Gets the list of defined globals Mocha Option: globals

Returns:

String[]:

getGrep

() String | Boolean

Defined in lib/task/mocha.js:227

Gets the test filter Mocha Option: grep

Returns:

String | Boolean:

getLabel

() String

Inherited from AbstractTask: lib/abstractTask.js:337

Gets the label of the task

Returns:

String:

getMochaConfiguration

() Object

Defined in lib/task/mocha.js:116

Gets the mocha configuration Overwrite this function if the mocha configuration is found somewhere else.

Returns:

Object:

getName

() String

Inherited from AbstractTask: lib/abstractTask.js:193

Gets the name of the preceptor task

Returns:

String:

getOptions

() Object

Inherited from AbstractTask: lib/abstractTask.js:123

Gets the options

Returns:

Object:

getPaths

() String[]

Defined in lib/task/mocha.js:282

Gets the path of all tests Mocha Option:

Returns:

String[]:

getPlugins

() Object

Inherited from AbstractTask: lib/abstractTask.js:284

Gets all plugins

Returns:

Object:

getRecursive

() Boolean

Defined in lib/task/mocha.js:304

Should the test-search be recursive? Mocha Option: recursive

Returns:

Boolean:

getReporter

() String

Defined in lib/task/mocha.js:139

Gets the reporter Mocha Option: reporter

Returns:

String:

getReportManager

() ReportManager

Inherited from AbstractTask: lib/abstractTask.js:326

Gets the report manager

Returns:

ReportManager:

getRequire

() String[]

Defined in lib/task/mocha.js:315

List of files to be required before the tests are run Mocha Option: require

Returns:

String[]:

getSlowThreshold

() Int

Defined in lib/task/mocha.js:183

Gets the threshold for slow tests Mocha Option: slow

Returns:

Int:

getTaskDecoratorPlugins

() AbstractTaskDecorator[]

Inherited from AbstractTask: lib/abstractTask.js:294

Gets all options-decorator plugins

Returns:

AbstractTaskDecorator[]:

getTaskId

() String

Inherited from AbstractTask: lib/abstractTask.js:183

Gets a unique id for the task

Returns:

String:

getTaskPlugin

(
  • name
)
AbstractTask

Inherited from AbstractTask: lib/abstractTask.js:314

Gets a specific task plugin

Parameters:

Returns:

AbstractTask:

getTimeOut

() Int

Defined in lib/task/mocha.js:205

Gets the threshold for too slow test-suites Mocha Option: timeout

Returns:

Int:

getTitle

() String

Inherited from AbstractTask: lib/abstractTask.js:203

Gets the title of the preceptor task

Returns:

String:

getType

() String

Inherited from AbstractTask: lib/abstractTask.js:173

Gets the type of the preceptor task

Returns:

String:

getUi

() String

Defined in lib/task/mocha.js:150

Gets the UI interface ('tdd', 'bdd') Mocha Option: ui

Returns:

String:

inDebug

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:223

Is the task in debug-mode?

Returns:

Boolean:

initialize

()

Inherited from AbstractTask but overwritten in lib/task/mocha.js:17

Initializes the instance

isActive

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:233

Is the task active?

Returns:

Boolean:

isSuite

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:213

Run tasks in a suite?

Returns:

Boolean:

isVerbose

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:243

Is the task verbose?

Returns:

Boolean:

run

(
  • parentId
)
Promise

Inherited from AbstractTask: lib/abstractTask.js:348

Run the task

Parameters:

Returns:

Promise:

runClient

(
  • parentId
  • clientPath
)
Promise

Inherited from AbstractForkTask: lib/abstractForkTask.js:43

Runs the client in a forked environment

Parameters:

Returns:

Promise:

setMochaConfiguration

(
  • options
)

Defined in lib/task/mocha.js:127

Sets the mocha configuration Overwrite this function if the mocha configuration is found somewhere else.

Parameters:

shouldBail

() Boolean

Defined in lib/task/mocha.js:216

Should mocha bail on first error? Mocha Option: bail

Returns:

Boolean:

shouldCheckLeaks

() Boolean

Defined in lib/task/mocha.js:249

Should mocha check for leaks Mocha Option: check-leaks

Returns:

Boolean:

shouldEchoStdErr

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:273

Echo std-err output of child-process?

Returns:

Boolean:

shouldEchoStdOut

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:263

Echo std-out output of child-process?

Returns:

Boolean:

shouldFailOnError

() Boolean

Inherited from AbstractForkTask: lib/abstractForkTask.js:33

Should task fail on error?

Returns:

Boolean:

shouldInvert

() Boolean

Defined in lib/task/mocha.js:238

Should the test sequence inverted? Mocha Option: invert

Returns:

Boolean:

shouldReport

() Boolean

Inherited from AbstractTask: lib/abstractTask.js:253

Should report?

Returns:

Boolean:

shouldSort

() Boolean

Defined in lib/task/mocha.js:326

Should tests be sorted after gathering and before executing? Mocha Option: sort

Returns:

Boolean:

useAsyncOnly

() Boolean

Defined in lib/task/mocha.js:260

Gets the reporter Mocha Option: async-only

Returns:

Boolean:

useColors

() Boolean

Defined in lib/task/mocha.js:161

Should colors be used in output? Mocha Option: colors

Returns:

Boolean:

useInlineDiffs

() Boolean

Defined in lib/task/mocha.js:172

Output inline diffs Mocha Option: inline-diffs

Returns:

Boolean:

useTimeOuts

() Boolean

Defined in lib/task/mocha.js:194

Should time-outs be observed? Mocha Option: [no-]timeouts

Returns:

Boolean:

validate

()

Inherited from AbstractTask but overwritten in lib/task/mocha.js:51

Validates the given data