klimentru1986 / log4deno Goto Github PK

Log4deno

License: MIT License

TypeScript 100.00%

log4deno's Introduction

log4deno

Overview

log4deno is a tool to help the programmer output log statements to a variety of output targets. In case of problems with an application, it is helpful to enable logging so that the problem can be located.

Features

Usage

Simple

/** Create instance */
export const logger = new Logger();

/** Usage */
logger.debug('debug message');
logger.info('info');

/** Usage with chain */
logger
    .warn('warn message')
    .error(new Error('error message'))
    .critical(new Error('critical message'));

Error logger

/** Write to file only error and critical */
const logger = new Logger();
const config: LoggerConfig = {
    error: {
        types: 'file',
        fileName: 'Error.log',
        logFolder: './Logs/Errors',
        logLevel: ['ERROR', 'CRITICAL']
    }
}

logger.configure(config);

Custom format

const logger = new Logger();
const config: LoggerConfig = {
    formattedLogs: {
        logFormat: '$level - $date',
        dateFormat: 'dd.MMMM.yyyy',
    }
};

logger.configure(config);

Multiple configurations

const logger = new Logger();

/** Static config */
const config: LoggerConfig = {
    default: {
        types: ['console', 'file'],
        fileName: 'LogFile.log',
        logLevel: ['INFO', 'WARN', 'ERROR', 'CRITICAL']
    },
    error: {
        types: 'file',
        fileName: 'Error.log',
        logFolder: './Logs/Errors',
        logLevel: ['ERROR', 'CRITICAL']
    }
};

/** Enabled only in debug mode */
isDebug && (config.debug = {
    types: 'console',
    logLevel: ['DEBUG']
})

logger.configure(config);

Configuration

types: Array<'console' | 'file'>
logFolder: folder for logs
fileName: log file name
logLevel: Array<'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'CRITICAL'>
logFormat: log info output format
dateFormat: date output format

Default configuration

export const defaultConfig: LoggerConfig = {
    default: {
        types: ['console', 'file'],
        logFolder: './Logs',
        fileName: 'LogFile.log',
        logLevel: ['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL']
        logFormat: '[$date] [$level] [$name]',
        dateFormat: 'yyyy-MM-dd HH:mm:ss',
    }
}