Log

A thin & fast logger system.

An instance is created by the app and available to use anywhere like this:

... anywhere inside your code
this.app.log.debug(...)

Shortcuts to log's methods are also available on every Bajo plugin. Call on these shortcuts will be prefixed with it's plugin name automatically:

... anywhere inside your code
if (!isValid) this.log.error('Invalid value!')

Constructor

new Log(app)

Parameters:
NameTypeDescription
appApp

App instance

Members

app :App

The app instance.

Type:

dispose

Dispose internal references.

Methods

debug(prefix, …params)

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

Parameters:
NameTypeAttributesDescription
prefixstring

Message prefix.

paramsany<repeatable>

Parameters.

error(prefix, …params)

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

Parameters:
NameTypeAttributesDescription
prefixstring

Message prefix.

paramsany<repeatable>

Parameters.

fatal(prefix, …params)

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

Parameters:
NameTypeAttributesDescription
prefixstring

Message prefix.

paramsany<repeatable>

Parameters.

formatMsg(level, prefix, …params)

Display & format message according to one of these rules:

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

In prod environment, log will be delivered as JSON stringified object. See TLogJson for more info

Parameters:
NameTypeAttributesDescription
levelstring

Log level to use.

prefixstring

Prefix to the message.

paramsany<repeatable>

See format above.

getRotationPattern(isPrev) → {string}

Calculate pattern used for log rotation.

Parameters:
NameTypeDescription
isPrevboolean

If true, calculate previous rotation pattern.

Returns:

Calculated pattern.

Type: 
string

info(prefix, …params)

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

Parameters:
NameTypeAttributesDescription
prefixstring

Message prefix.

paramsany<repeatable>

Parameters.

save(text, prefix)

Save log to file in {dataDir}/log.

Parameters:
NameTypeDescription
textstring

Log message to save.

prefixstring

Use prefix as basename. Defaults to 'bajo'.

silent(prefix, …params)

Display & format message in silent level. See formatMsg for details.

Parameters:
NameTypeAttributesDescription
prefixstring

Message prefix.

paramsany<repeatable>

Parameters.

trace(prefix, …params)

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

Parameters:
NameTypeAttributesDescription
prefixstring

Message prefix.

paramsany<repeatable>

Parameters.

warn(prefix, …params)

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

Parameters:
NameTypeAttributesDescription
prefixstring

Message prefix.

paramsany<repeatable>

Parameters.