Class: Log

Constructor

new Log(app)

Constructor.

Parameters:

Name	Type	Description
`app`	App	App instance

Source: class/log.js, line 75

Members

_lastDelta :number

Last delta time in millisecond since app started. Used for log's time taken feature.

Type:

number

Source: class/log.js, line 85

app :App

The app instance.

Type:

Source: class/log.js, line 90

Methods

debug(prefix, …params)

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

Parameters:

Name	Type	Attributes	Description
`prefix`	string		Message prefix
`params`	any	<repeatable>	Parameters

Source: class/log.js, line 246

(async) dispose() → {Promise.<void>}

Dispose internal references.

Source: class/log.js, line 312

Returns:

Type:: Promise.<void>

error(prefix, …params)

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

Parameters:

Name	Type	Attributes	Description
`prefix`	string		Message prefix
`params`	any	<repeatable>	Parameters

Source: class/log.js, line 279

fatal(prefix, …params)

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

Parameters:

Name	Type	Attributes	Description
`prefix`	string		Message prefix
`params`	any	<repeatable>	Parameters

Source: class/log.js, line 290

formatMsg(level, prefix, …params)

Display & format message according to one of these rules:

level prefix text var 1 var 2 ...var n - Translate text and interpolate with vars for level level
level prefix data text var 1 var 2 ...var n - As above, and append stringified data
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 Log.TJsonOutput for more info

Parameters:

Name	Type	Attributes	Description
`level`	string		Log level to use
`prefix`	string		Prefix to the message
`params`	any	<repeatable>	See format above

Source: class/log.js, line 112
See: Err
Log.TJsonOutput

getErrorMessage(error) → {string}

Get error message from an Error object. If the message is empty, return the code or statusCode instead.

Parameters:

Name	Type	Description
`error`	Error	Error object

Source: class/log.js, line 170

Returns:

Error message

Type:: string

getRotationPattern(isPrev) → {string}

Calculate pattern used for log rotation. Used by save method to determine the log file name.

Parameters:

Name	Type	Description
`isPrev`	boolean	If `true`, calculate previous rotation pattern.

Source: class/log.js, line 182

Returns:

Calculated pattern

Type:: string

info(prefix, …params)

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

Parameters:

Name	Type	Attributes	Description
`prefix`	string		Message prefix
`params`	any	<repeatable>	Parameters

Source: class/log.js, line 257

save(text, prefixopt)

Save log to file in {dataDir}/log.

Parameters:

Name	Type	Attributes	Default	Description
`text`	string			Log message to save
`prefix`	string	<optional>	'bajo'	Use prefix as basename. Defaults to `bajo`

Source: class/log.js, line 215

silent(prefix, …params)

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

Parameters:

Name	Type	Attributes	Description
`prefix`	string		Message prefix
`params`	any	<repeatable>	Parameters

Source: class/log.js, line 301

trace(prefix, …params)

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

Parameters:

Name	Type	Attributes	Description
`prefix`	string		Message prefix
`params`	any	<repeatable>	Parameters

Source: class/log.js, line 235

warn(prefix, …params)

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

Parameters:

Name	Type	Attributes	Description
`prefix`	string		Message prefix
`params`	any	<repeatable>	Parameters

Source: class/log.js, line 268

Type Definitions

TJsonOutput

Log output in stringified JSON format. Returned when app run in prod environment.

Properties

Name	Type	Attributes	Description
`prefix`	string		Message prefix.
`message`	string		The message itself.
`level`	string		Log level.
`time`	number		Time in millisecond.
`pid`	number		Process ID.
`hostname`	string		Hostname.
`data`	Object	<optional>	Payload data, if any.

Source: class/log.js, line 42
See: Log#formatMsg

TLevels

Type:

Object

Properties

Name Type Description

trace

Object

Properties

Name	Type	Attributes	Default	Description
`number`	number	<optional>	10
`color`	string	<optional>	gray

debug

Object

Properties

Name	Type	Attributes	Default	Description
`number`	number	<optional>	20
`color`	string	<optional>	greenBright

info

Object

Properties

Name	Type	Attributes	Default	Description
`number`	number	<optional>	30
`color`	string	<optional>	blueBright

warn

Object

Properties

Name	Type	Attributes	Default	Description
`number`	number	<optional>	40
`color`	string	<optional>	yellowBright

error

Object

Properties

Name	Type	Attributes	Default	Description
`number`	number	<optional>	50
`color`	string	<optional>	redBright

fatal

Object

Properties

Name	Type	Attributes	Default	Description
`number`	number	<optional>	60
`color`	string	<optional>	magentaBright

silent

Object

Properties

Name	Type	Attributes	Default	Description
`number`	number	<optional>	99
`color`	string	<optional>	white

Source: class/log.js, line 5