Class ReportingManager

constructor

• new ReportingManager(name, aftCfg?): ReportingManager

• Parameters

  • name: string

  • Optional aftCfg: AftConfig

  Returns ReportingManager

Readonly aftCfg

Readonly logger

Readonly name

Readonly plugins

logLevel

• get logLevel(): "trace" | "debug" | "info" | "step" | "warn" | "pass" | "fail" | "error" | "none"

• the LogLevel governing output to this instance's console logger. the value can be modified by passing in a custom AftConfig instance where the logLevel has been set or by simply specifying a logLevel in your aftconfig.json

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

debug

• debug(message, ...data): Promise<void>

• calls the log function with a LogLevel of debug

  Parameters

  • message: string

    the message to be logged

  • Rest ...data: any[]

  Returns Promise<void>

error

• error(message, ...data): Promise<void>

• calls the log function with a LogLevel of error

  Parameters

  • message: string

    the message to be logged

  • Rest ...data: any[]

  Returns Promise<void>

fail

• fail(message, ...data): Promise<void>

• calls the log function with a LogLevel of fail

  Parameters

  • message: string

    the message to be logged

  • Rest ...data: any[]

  Returns Promise<void>

finalise

• finalise(): Promise<void>

• loops through any loaded ReportingPlugin objects and calls their finalise function. This should be called upon completion of any logging actions before destroying the AftLogger instance

  Returns Promise<void>

info

• info(message, ...data): Promise<void>

• calls the log function with a LogLevel of info

  Parameters

  • message: string

    the message to be logged

  • Rest ...data: any[]

  Returns Promise<void>

log

• log(level, message, ...data): Promise<void>

• function will log to the console and then send the LogLevel, message and data on to any loaded ReportingPlugin objects

  Parameters

  • level: "trace" | "debug" | "info" | "step" | "warn" | "pass" | "fail" | "error" | "none"

    the LogLevel of this message

  • message: string

    the string to be logged

  • Rest ...data: any[]

    an array of additional data to be included in the logs

  Returns Promise<void>

pass

• pass(message, ...data): Promise<void>

• calls the log function with a LogLevel of pass

  Parameters

  • message: string

    the message to be logged

  • Rest ...data: any[]

  Returns Promise<void>

step

• step(message, ...data): Promise<void>

• calls the log function with a LogLevel of step

  Parameters

  • message: string

    the message to be logged

  • Rest ...data: any[]

  Returns Promise<void>

submitResult

• submitResult(result): Promise<void>

• function will send the passed in TestResult to any loaded IResultsPlugin implementations allowing them to process the result

  Parameters

  • result: TestResult

    a TestResult object to be sent

  Returns Promise<void>

trace

• trace(message, ...data): Promise<void>

• calls the log function with a LogLevel of trace

  NOTE

  this is typically reserved for AFT internal systems and will result in much more verbose logs if enabled

  Parameters

  • message: string

    the message to be logged

  • Rest ...data: any[]

  Returns Promise<void>

warn

• warn(message, ...data): Promise<void>

• calls the log function with a LogLevel of warn

  Parameters

  • message: string

    the message to be logged

  • Rest ...data: any[]

  Returns Promise<void>