API Docs for: 0.9.1
Show:

PreceptorReporter Class

Constructor

PreceptorReporter

()

Methods

complete

()

Reporting is completed

console

(
  • id
  • msgType
  • msg
)

Sends data to stdout

Parameters:

getConfiguration

() Object

Gets the configuration supplied

Returns:

getContainer

() ReportContainer

Gets the container

Returns:

getOptions

() Object

Gets the options

Returns:

getOutput

() String

Gets the collected output

Returns:

getPath

() String

Output path

Returns:

getType

() String

Gets the type of reporter

Returns:

initialize

()

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:18

Initializes the instance

itemData

(
  • id
  • json
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:51

Called when any item has custom data

Parameters:

itemMessage

(
  • id
  • message
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:63

Called when any item has a custom message

Parameters:

output

(
  • data
)

Outputs data to stdout

Parameters:

shouldOutput

() Boolean

Should the reporter output the data?

Returns:

shouldShowProgress

() Boolean

Should the reporter show progress?

Returns:

start

()

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:40

Called when reporting starts

stop

()

Called when reporting stops

suiteEnd

(
  • id
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:89

Called when suite ends

Parameters:

suiteStart

(
  • id
  • parentId
  • suiteName
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:76

Called when suite starts

Parameters:

testError

(
  • id
  • [message]
  • [reason]
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:128

Called when test has an error

Parameters:

testFailed

(
  • id
  • [message]
  • [reason]
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:115

Called when test fails

Parameters:

testIncomplete

(
  • id
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:175

Called when test is incomplete

Parameters:

testPassed

(
  • id
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:141

Called when test has passed

Parameters:

testSkipped

(
  • id
  • [reason]
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:163

Called when test is skipped

Parameters:

testStart

(
  • id
  • parentId
  • testName
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:101

Called when test starts

Parameters:

testUndefined

(
  • id
)

Inherited from AbstractReporter but overwritten in lib/reporter/preceptor.js:152

Called when test is undefined

Parameters:

toString

() String

Exports data to a string

Returns:

useColor

() Boolean

Should reporter use color?

Returns:

write

()

Writes the data into an output file