loglevel Message prefix plugin

Plugin for loglevel which allows defining prefixes for log messages

Usage

Installation

Clone the sources and install the package (In the source directory) on command line using npm:

1npm install

Testing

Run the following NPM script to lint, test and check coverage of the code:

1
2npm run check
3

AMD

1
2define(['loglevel', 'loglevel-message-prefix'], function(log, loglevelMessagePrefix) {
3
4  loglevelMessagePrefix(log, {
5    staticPrefixes: ['foobar']
6  });
7
8  log.warn('TEST');
9
10});
11

Node.js require

1
2var log = require('loglevel');
3var loglevelMessagePrefix = require('loglevel-message-prefix');
4
5loglevelMessagePrefix(log, {
6  staticPrefixes: ['foobar']
7});
8
9log.warn('TEST');
10

Example

Code:

1
2var log = require('loglevel-message-prefix')(require('loglevel'), {
3    prefixes: ['level'],
4    staticPrefixes: ['foo', 'bar'],
5    separator: '/'
6});
7
8log.setLevel('info');
9
10log.info('Testing');
11

Output:

[INFO/foo/bar]: Testing

Configuration

The configuration object is passed as the second argument to the function. Following properties are supported ():

• prefixes: An array of predefined dynamic prefixes that are to be used. Defaults to: ['timestamp', 'level']. Available prefixes are:
  • timestamp: Add locale-specific timestamp
  • level: Add log level prefix
• staticPrefixes: An array of strings that should be added after dynamic prefixes (E.g. 'foo'). Defaults to none.
• prefixFormat: A string template to format the prefix (%p is replaced with the prefix). Defaults to [%p]:
• separator: String used to separate prefixes. Defaults to single whitespace ( ).
• options: Options for dynamic prefixes. Available options are:
  • timestamp: An object of properties for date formatting. Available properties are: locale, timezone and hour12. Defaults to {hour12: false}

The properties are defined the schema file.

License and copyright

Copyright (c) 2015-2016 University Of Helsinki (The National Library Of Finland)

This project's source code is licensed under the terms of MIT License.