# cp.spec.DefaultHandler

Default implementation of Handler, which outputs via the standard print function.


# API Overview

Methods - API calls which can only be made on an object returned by a constructor

  • aborted
  • failed
  • filter
  • printf
  • printSpacer
  • start
  • stop
  • summary
  • waiting

# API Documentation

# Methods

# aborted

Signature cp.spec.DefaultHandler:aborted(run, msg)
Type Method
Description Prints an "[ABORT]" message.
Parameters
  • run - the run
  • msg - the message string.
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/DefaultHandler.lua line 110

# failed

Signature cp.spec.DefaultHandler:failed(run, msg) -> none
Type Method
Description Prints a "[FAIL]" message.
Parameters
  • run - the run
  • msg - the message string.
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/DefaultHandler.lua line 96

# filter

Signature cp.spec.DefaultHandler:filter(run, msg) -> none
Type Method
Description Prints a "[FILTER]" message.
Parameters
  • run - the run
  • msg - the message string.
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/DefaultHandler.lua line 141

# printf

Signature cp.spec.DefaultHandler:printf(test, ...)
Type Method
Description Prints a spacer (if not the first line), followed by the text, optionally formatted with the provided parameters.
Parameters
  • text - The message to print.
  • ... - The parameters to interpolate into the text message.
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/DefaultHandler.lua line 38

# printSpacer

Signature cp.spec.DefaultHandler:printSpacer()
Type Method
Description Prints a blank line if this is not the first time it has been called.
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/DefaultHandler.lua line 22

# start

Signature cp.spec.DefaultHandler:start(run, msg)
Type Method
Description If the handler or run is verbose, prints a "[PASS]" message.
Parameters
  • run - the run
  • msg - the message string.
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/DefaultHandler.lua line 79

# stop

Signature cp.spec.DefaultHandler:stop(run)
Type Method
Description If the handler or run is verbose, prints a "[STOP]" message.
Parameters
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/DefaultHandler.lua line 66

# summary

Signature cp.spec.DefaultHandler:summary(run, report) -> none
Type Method
Description If the handler or run is verbose, prints a "[RESULT]" message.
Parameters
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/DefaultHandler.lua line 155

# waiting

Signature cp.spec.DefaultHandler:waiting(run, timeout) -> none
Type Method
Description Prints a "[WAIT]" message with the timeout value..
Parameters
  • run - run
  • timeout - timeout
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/DefaultHandler.lua line 124