API Docs for: 0.9.1
Show:

PreceptorMessenger Class

Extends AbstractMessenger
Defined in: lib/messenger/preceptor.js:6

Constructor

PreceptorMessenger

()

Defined in lib/messenger/preceptor.js:6

Methods

_send

(
  • messageType
  • data
  • [options]
)
private

Defined in lib/messenger/preceptor.js:14

Sends a message

Parameters:

_sendIntro

(
  • [options]
)
private

Defined in lib/messenger/preceptor.js:28

Sends intro message

Parameters:

getOptions

() Object

Inherited from AbstractMessenger: lib/abstractMessenger.js:45

Gets the options

Returns:

Object:

initialize

()

Inherited from AbstractMessenger: lib/abstractMessenger.js:35

Initializes the instance

itemData

(
  • id
  • json
  • [options]
)

Defined in lib/messenger/preceptor.js:55

Item has custom data

Parameters:

itemMessage

(
  • id
  • message
  • [options]
)

Defined in lib/messenger/preceptor.js:68

Item has a custom message

Parameters:

output

(
  • data
)

Inherited from AbstractMessenger: lib/abstractMessenger.js:82

Outputs data to stdout

Parameters:

shouldOutput

() Boolean

Inherited from AbstractMessenger: lib/abstractMessenger.js:55

Should the messages be printed?

Returns:

Boolean:

suiteEnd

(
  • id
  • [options]
)

Defined in lib/messenger/preceptor.js:96

Suite ends

Parameters:

suiteStart

(
  • id
  • parentId
  • suiteName
  • [options]
)

Defined in lib/messenger/preceptor.js:82

Suite starts

Parameters:

testError

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

Defined in lib/messenger/preceptor.js:138

Test has an error

Parameters:

testFailed

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

Defined in lib/messenger/preceptor.js:124

Test fails

Parameters:

testIncomplete

(
  • id
  • [options]
)

Defined in lib/messenger/preceptor.js:189

Test is incomplete

Parameters:

testPassed

(
  • id
  • [options]
)

Defined in lib/messenger/preceptor.js:152

Test has passed

Parameters:

testSkipped

(
  • id
  • [reason]
  • [options]
)

Defined in lib/messenger/preceptor.js:176

Test is skipped

Parameters:

testStart

(
  • id
  • parentId
  • testName
  • [options]
)

Defined in lib/messenger/preceptor.js:109

Test starts

Parameters:

testUndefined

(
  • id
  • [options]
)

Defined in lib/messenger/preceptor.js:164

Test is undefined

Parameters:

trigger

(
  • msg
  • [options]
)

Inherited from AbstractMessenger: lib/abstractMessenger.js:66

Triggers a message

Parameters:

version

(
  • [options]
)

Defined in lib/messenger/preceptor.js:43

Sends the version as message

Parameters: