class to be extended by any Plugin implementation

Hierarchy

Constructors

Accessors

  • get logLevel(): "trace" | "debug" | "info" | "step" | "warn" | "pass" | "fail" | "error" | "none"
  • allows for filtering out of erroneous information from logs by assigning values to different types of logging. the purpose of each log level is as follows:

    • trace - used when logging low-level debug events that occur within a loop
    • debug - used for debug logging that does not run within a loop or at a high frequency
    • info - used for informational events providing current state of a system
    • step - used within a test to denote where within the test steps we are
    • warn - used for unexpected errors that are recoverable
    • pass - used to indicate the success of a test expectation or assertion
    • fail - used to indicate the failure of a test expectation or assertion
    • error - used for unexpected errors that are not recoverable
    • none - used when no logging is desired (disables logging)

    Returns "trace" | "debug" | "info" | "step" | "warn" | "pass" | "fail" | "error" | "none"

Methods

  • called by the parent ReportingManager before terminating to allow each plugin to finalise any deferred logging actions

    Parameters

    • name: string

      the name of the ReportingManager instance calling finalise

    Returns Promise<void>

  • called by the parent ReportingManager on load to allow any plugins to configure themselves for a new logger

    Parameters

    • logName: string

      the name of the ReportingManager instance calling dispose

    Returns Promise<void>

Generated using TypeDoc