@dreipol/abstract-log

abstract-log

This npm package comprises the abstract core of the dreipol vue and react log utils.

Purpose

abstract-log simplifies the addition of a logger with multiple log levels to a host object.

Config

You can pass the following options keys:

@property logger {Object}

The log methods will be bound to this property as this value.

@property middlewares {Array}

The log output is controlled by passing a series of methods. As the first argument, every middleware will receive the input array as the first argument and a data object with the following keys as the second argument:

@param o.config {Object}

The logger's configuration object.

@param o.level {Object}

The invoked log level's config object that was passed within the levels config key.

@param o.instance {ViewModel}

When used within a vue component, the component instance that invoked the log method is passed as vm.

@param o.statements {Array}

This property is only defined, when proxy is set to false!
The array contains the arguments that the log method has been invoked with.

@return {Array}

The method's output is expected to be an array that is passed to the log method as an arglist.

@property proxy {boolean}

When this value is set to true, the log method will be directly bound to the logger value. You will lose the access to the log method arguments in the loggerArgs method. This is necessary for exmaple to ensure that stack traces in the console will maintain their original value instead of being bound to this plugin.
If you don't use console logs or don't need original stack traces, you can disable this option and gain the ability to customize your log messages according to the passed arguments.

@param context {any}

A completely customizable property that has been passed in the config when creating the logger.

@property levels {Array}

A list of log level objects that can be invoked by the logger. Each log level must contain at least the following keys:

@property fn {Function}

The log method that is being used by the log level.

@property name {string}

The logger will have a function of this name to invoke a log message.

@property filter {Function}

A method that receives the same object as the loggerArgs method.
The log message will be hidden in case of a falsey return value.

Middlewares

This package contains the following base middlewares:

colorize

The method applies a color to the part of the console output that is generated by the logger.
This concatenates previous output, forcing all previous statements to strings!

iconize

The method prepends the log level label to the output, for example to add an icon.

localize

The method prepends a location string to the output, if available. By default it appends the string that is given at config.context.location.