@bnguyensn/logger v0.3.0

Logger 📝

Provides basic logging functionality. Built on top of the wonderful chalk.

Opinionated for my own usage.

Install

Using npm:

$ npm install -D @bnguyensn/logger

Using yarn:

$ yarn add -D @bnguyensn/logger

Usage

Basic usage:

const logger = require('@bnguyensn/logger')();

logger.info('I am blue');
logger.success('I am green');
logger.warn('I am yellow');
logger.error('I am red');

With a base prefix and timestamp:

const logger = require('@bnguyensn/logger')({ base: 'LOG', timestamp: true });

logger.info("I will have 'LOG' prepended and also have a timestamp");

API

createLogger(config)

This is the function exported by the module. You get this from calling require('@bnguyensn/logger').

createLogger(), when called, will return a Logger instance.

The config object by default is undefined.

config

timestampOptions

This object describes how the timestamp for each logging message should look like. We use Node's toLocaleDateString() under the hood.

Logger

An instance of Logger is returned from calling createLogger().

This Logger instance can then be used to log stuff to the terminal.

Each Logger has the following methods: