Install

npm i -D nv-log

⚠️ We do not recommend installing this module globally

Usage

// default name nv3
const logger = require('nv-log').logger;
logger.info('Server Starting');

import {logger, loggerColors, loggerSymbols} from 'nv-log'
logger.info('Server Starting');
loggerColors.green('message')
loggerSymbols.debug

ℹ️ The logger returned is unique by default, due to the nature of the nv ecosystem. Please reference the unique option below for disabling this feature and to force caching

Options

| Name | Type | Default | Description | | :---------------------------: | :---------: | :------------: | :---------------------- | | name | {String} | ''<unknown>' | Log Name (Required) | | level | {String} | 'info' | Log Level | | unique | {Boolean} | true | Log Uniqueness | | timestamp | {Boolean} | false | Log Timestamps |

name

Specifies the name of the log to create. This option is required, and used to differentiate between loggers when nv-log is used in multiple projects executing in the same process

const logger = log({ name: 'wds' });

level

Specifies the level the logger should use. A logger will not produce output for any log level beneath the specified level. Available levels and order are:

['info', 'warn', 'error', 'trace', 'debug', 'silent'];

const logger = log({ level: 'error' });

logger.error(err);

ℹ️ The level names shown above correspond to the available logging methods, with the notable exception of the silent level

unique

If false, instructs the logger to used cached versions of a log with the same name. Due to the nature of the nv ecosystem and multiple plugin/loader usage in the same process, loggers are created as unique instances by default. By passing false for this property, the module is instructed to cache the requested logger

const logger = log({ unique: true });

timestamp

If true, instructs the logger to display a timestamp for log output, preceding all other data

const logger = log({ timestamp: true });