MMIR Framework

Class: Logger

Logger

new mmir.tools.Logger(theName, theLevel)

tools/logger.js, line 572
Constructor-Method of Class Logger
Name Type Description
theName String the name / ID for the logger
theLevel String | Number optional OPTIONAL the log-level. If omitted, the logger will use the default log-level
See:
  • getAsLevel
  • getLevel

Methods

c(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 992
Alias for critical.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

critical(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 813
Print a critical (exception) log message, if at least critical (5) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

d(className, funcName, msg, reverseCallStack)

tools/logger.js, line 944
Alias for debug.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

debug(className, funcName, msg, reverseCallStack)

tools/logger.js, line 721
Print a debug log message, if at least debug (1) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

e(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 980
Alias for error.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

error(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 789
Print an error log message, if at least error (4) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

getLevel(){Number}

tools/logger.js, line 632
Get the current log-level: if a specific log-level for this Logger instance is set, this value is returned. Otherwise, the default log-level as returned by mmir.Logging#getDefaultLogLevel is used. Log-levels:
  • 0: verbose
  • 1: debug
  • 2: info
  • 3: warn
  • 4: error
  • 5: critical
  • 6: disabled
See:
Returns:
Type Description
Number the logging level

i(className, funcName, msg, reverseCallStack)

tools/logger.js, line 956
Alias for info.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

info(className, funcName, msg, reverseCallStack)

tools/logger.js, line 743
Print an information log message, if at least info (2) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

isc(){Boolean}

tools/logger.js, line 1068
Alias for isCritical.
See:
Returns:
Type Description
Boolean true if at least log-level critical (5)

isCritical(){Boolean}

tools/logger.js, line 899
Check if the current log-level is at least critical.
See:
Returns:
Type Description
Boolean true if at least log-level critical (5)

isd(){Boolean}

tools/logger.js, line 1020
Alias for isDebug.
See:
Returns:
Type Description
Boolean true if at least log-level debug (1)

isDebug(){Boolean}

tools/logger.js, line 843
Check if the current log-level is at least debug.
See:
Returns:
Type Description
Boolean true if at least log-level debug (1)

isDisabled(){Boolean}

tools/logger.js, line 913
Check if the current log-level is at least disabled.
See:
Returns:
Type Description
Boolean true if at least log-level disable (6)

ise(){Boolean}

tools/logger.js, line 1056
Alias for isError.
See:
Returns:
Type Description
Boolean true if at least log-level error (4)

isError(){Boolean}

tools/logger.js, line 885
Check if the current log-level is at least error.
See:
Returns:
Type Description
Boolean true if at least log-level error (4)

isi(){Boolean}

tools/logger.js, line 1032
Alias for isInfo.
See:
Returns:
Type Description
Boolean true if at least log-level info (2)

isInfo(){Boolean}

tools/logger.js, line 857
Check if the current log-level is at least info.
See:
Returns:
Type Description
Boolean true if at least log-level info (2)

isv(){Boolean}

tools/logger.js, line 1008
Alias for isVerbose.
See:
Returns:
Type Description
Boolean true if at least log-level verbose (0)

isVerbose(){Boolean}

tools/logger.js, line 829
Check if the current log-level is at least verbose.
See:
Returns:
Type Description
Boolean true if at least log-level verbose (0)

isw(){Boolean}

tools/logger.js, line 1044
Alias for isWarn.
See:
Returns:
Type Description
Boolean true if at least log-level warn (3)

isWarn(){Boolean}

tools/logger.js, line 871
Check if the current log-level is at least warn.
See:
Returns:
Type Description
Boolean true if at least log-level warn (3)

l(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 920
Alias for log.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

log(className, funcName, msg, error, reverseCallStack)

tools/logger.js, line 676
Print a log message, if at least debug log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
error Error optional OPTIONAL an error object: if available, its message and error-stack will be print to the output
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

setLevel(loggingLevel)

tools/logger.js, line 650
Set the logging level.
Name Type Description
loggingLevel String | Number if {Number} the logging level as a number if {String} the logging level as a string (see getLevel)
See:

v(className, funcName, msg, reverseCallStack)

tools/logger.js, line 932
Alias for verbose.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

verbose(className, funcName, msg, reverseCallStack)

tools/logger.js, line 699
Print a verbose log message, if at least verbose (0) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

w(className, funcName, msg, reverseCallStack)

tools/logger.js, line 968
Alias for warn.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.

warn(className, funcName, msg, reverseCallStack)

tools/logger.js, line 765
Print a warning log message, if at least warn (3) log-level is set.
Name Type Description
className String optional OPTIONAL the name of the class/object from which the logging is invoked from
funcName String optional OPTIONAL the name of the function (within the class) from which the logging is invoked from
msg String the log message
reverseCallStack number optional OPTIONAL offset when printing the callstack position/information: a positive number will go further back/up the callstack. This can be used in logging-helper functions to select the invoking function's position from the callstack instead of printing the information of the logging-helper function itself.