https://github.com/arlac77/loglevel-mixin
mixin to declare logging methods named after a given set of log levels
https://github.com/arlac77/loglevel-mixin
logging loglevel mixin
Last synced: about 1 year ago
JSON representation
mixin to declare logging methods named after a given set of log levels
- Host: GitHub
- URL: https://github.com/arlac77/loglevel-mixin
- Owner: arlac77
- License: 0bsd
- Created: 2015-12-25T13:09:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2025-04-05T11:35:58.000Z (about 1 year ago)
- Last Synced: 2025-04-05T12:27:12.496Z (about 1 year ago)
- Topics: logging, loglevel, mixin
- Language: JavaScript
- Size: 3.19 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/loglevel-mixin)
[](https://spdx.org/licenses/0BSD.html)
[](https://typescriptlang.org)
[](https://bundlejs.com/?q=loglevel-mixin)
[](https://npmjs.org/package/loglevel-mixin)
[](https://github.com/arlac77/loglevel-mixin/issues)
[](https://actions-badge.atrox.dev/arlac77/loglevel-mixin/goto)
[](https://github.com/prettier/prettier)
[](http://commitizen.github.io/cz-cli/)
[](https://snyk.io/test/github/arlac77/loglevel-mixin)
[](https://coveralls.io/github/arlac77/loglevel-mixin)
# loglevel-mixin
Injects methods named after a set of logLevels which are only forwarding messages. If the current logLevel is higher or equal to the logLevel the name of the called method reflects.
So the model object itself can be used as a logger and the log level is directly attaches to the model
# usage
```javascript
import { LogLevelMixin } from 'loglevel-mixin';
const LoggingEnabledClass = LogLevelMixin(
class BaseClass {
log(level, message) {
console.log(`${level} ${message}`);
}
}
);
const someObject = new LoggingEnabledClass();
someObject.logLevel = 'error';
someObject.info(
severity => 'my info message (not reported since logLevel is error)'
);
someObject.logLevel = 'info';
someObject.info(
severity => 'my info message (reported since logLevel is now info)'
);
```
# install
With [npm](http://npmjs.org) do:
```shell
npm install loglevel-mixin
```
# API
### Table of Contents
* [Logger](#logger)
* [Properties](#properties)
* [Loglevel](#loglevel)
* [Properties](#properties-1)
* [defaultLogLevels](#defaultloglevels)
* [declareLevels](#declarelevels)
* [Parameters](#parameters)
* [defineLoggerMethods](#defineloggermethods)
* [Parameters](#parameters-1)
* [Examples](#examples)
* [LogLevelMixin](#loglevelmixin)
* [Parameters](#parameters-2)
* [Examples](#examples-1)
* [makeLogEvent](#makelogevent)
* [Parameters](#parameters-3)
## Logger
Type: [Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)
### Properties
* `entry` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
## Loglevel
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
### Properties
* `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**
* `priority` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**
## defaultLogLevels
default log levels
* trace
* debug
* info
* notice
* warn
* error
* crit
* alert
## declareLevels
Generate the loglevel objects out of a list of log level names.
### Parameters
* `list` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** A list of log level names. The last name in the list will become the one with the highest priority.
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** levels object a hash with all the loglevels. Stored by there name.
## defineLoggerMethods
Adds logging methods to an existing object.
For each loglevel a method with the name of the log level will be created.
### Parameters
* `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** target where to assign properties to
* `logLevels` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Hash with all the available loglevels. Stored by there name (optional, default `defaultLogLevels`)
* `theFunction` **[Logger](#logger)?** to be added under the loglevel name.
This function will only be called if the current loglevel is greater equal
the log level of the called logging function.
By default a method log(level,message) will be used
### Examples
```javascript
defineLoggerMethods( obj)
obj.info('info entry'); // will redirect to theFunction if obj.loglevel is at least info
obj.error('error entry'); // will redirect to theFunction if obj.loglevel is at least error
```
Returns **void**
## LogLevelMixin
### Parameters
* `superclass` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** class to be extendet
* `logLevels` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** Object with all the available loglevels. Stored by their name (optional, default `defaultLogLevels`)
* `initialLogLevel` **[Loglevel](#loglevel)** the default value for the logLevel property (optional, default `defaultLogLevels.info`)
### Examples
```javascript
import { LogLevelMixin } = from 'loglevel-mixin';
class BaseClass {
log(level, message) { console.log(`${level} ${message}`); }
}
class LoggingEnabledClass extends LogLevelMixin(BaseClass) {
}
```
Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** newly created class ready to be further extendet/used
## makeLogEvent
Helper function to aggregate values into a log event.
### Parameters
* `severity` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** log severity
* `arg` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object))** original log message - level may be overwritten
* `args` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** additional values to be merged into the final log event - values have precedence
Returns **{message: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}** } suitable for log event processing
# license
BSD-2-Clause