Namespace: logger

PFT. logger

Source:

Members

<static> DEBUG

Properties:
Name Type Description
DEBUG=1 number representing a low criticality level of logging. this should be reserved for debugging
Source:

<static> ERROR

Properties:
Name Type Description
ERROR=1 number representing the maximum criticality level of logging. this should be reserved for problems with execution that will block functionality
Source:

<static> INFO

Properties:
Name Type Description
INFO=1 number representing the normal criticality level of logging. this should be reserved for helpful state change information
Source:

<static> logLevel

Properties:
Name Type Argument Default Description
logLevel string <optional>
 "info" the minimum level of logging to output
Source:

<static> TRACE

Properties:
Name Type Description
TRACE=0 number an enum used to indicate that the current message is very low criticality. this should be reserved for highly detailed debugging
Source:

<static> WARN

Properties:
Name Type Description
WARN=1 number representing the moderate criticality level of logging. this should be reserved for potentially problematic state changes
Source:

Methods

<static> log(levelInt, message, includeStackTrace)

function will log the passed in message to the console based on the PFT.logger.logLevel where higher criticality of levels will be output
Parameters:
Name Type Argument Default Description
levelInt Integer a value of PFT.logger.TRACE, PFT.logger.DEBUG, PFT.logger.INFO, PFT.logger.WARN, or PFT.logger.ERROR to specify the criticality of the message
message string the message to be output if the level is equal to or higher than PFT.logger.logLevel
includeStackTrace boolean <optional>
 false if set to true the output message will be appended with the current execution stack
Source: