Log

A thin logger system.

Constructor

new Log(plugin)

Parameters:
NameTypeDescription
pluginObject

Plugin instance

Methods

child() → {Object}

Create child logger

Returns:

Child logger instance

Type: 
Object

debug(…params)

Display & format message as debug level. See formatMsg for details

Parameters:
NameTypeAttributesDescription
paramsany<repeatable>

error(…params)

Display & format message as error level. See formatMsg for details

Parameters:
NameTypeAttributesDescription
paramsany<repeatable>

fatal(…params)

Display & format message as fatal level. See formatMsg for details

Parameters:
NameTypeAttributesDescription
paramsany<repeatable>

formatMsg(level, …params)

Display & format message according to one of these rules:

  1. level text var 1 var 2 ...var n - Translate text and interpolate with vars for level level
  2. level data text var 1 var 2 ...var n - As above, and append stringified data
  3. level error - Format as error. If current log level is trace, dump the error object on screen
Parameters:
NameTypeAttributesDescription
levelstring

Log level to use

paramsany<repeatable>

See format above

info(…params)

Display & format message as info level. See formatMsg for details

Parameters:
NameTypeAttributesDescription
paramsany<repeatable>

init()

Initialize logger. Auto detect to use different logger via Bajo's config file

isExtLogger() → {boolean}

Do we use external logger or Bajo's built-in one?

Returns:
Type: 
boolean

isIgnored(level) → {boolean}

Is provided level being ignored by config?

Parameters:
NameTypeDescription
levelstring

Log level

Returns:
Type: 
boolean

trace(…params)

Display & format message as trace level. See formatMsg for details

Parameters:
NameTypeAttributesDescription
paramsany<repeatable>

warn(…params)

Display & format message as warn level. See formatMsg for details

Parameters:
NameTypeAttributesDescription
paramsany<repeatable>

write(text, …argsopt) → {string}

Interpolate and translate text via plugin's print engine. Check Print class for more information

Parameters:
NameTypeAttributesDescription
textstring

Text pattern to use

argsany<optional>
<repeatable>

Variables to interpolate with text pattern above

Returns:

Interpolated & translated text

Type: 
string