npm.io
1.2.0 • Published 4 years ago

iq-logger

Licence
ISC
Version
1.2.0
Deps
0
Size
13 kB
Vulns
0
Weekly
0

typescript

IQ Logger

██╗ ██████╗     ██╗      ██████╗  ██████╗  ██████╗ ███████╗██████╗ 
██║██╔═══██╗    ██║     ██╔═══██╗██╔════╝ ██╔════╝ ██╔════╝██╔══██╗
██║██║   ██║    ██║     ██║   ██║██║  ███╗██║  ███╗█████╗  ██████╔╝
██║██║▄▄ ██║    ██║     ██║   ██║██║   ██║██║   ██║██╔══╝  ██╔══██╗
██║╚██████╔╝    ███████╗╚██████╔╝╚██████╔╝╚██████╔╝███████╗██║  ██║
╚═╝ ╚══▀▀═╝     ╚══════╝ ╚═════╝  ╚═════╝  ╚═════╝ ╚══════╝╚═╝  ╚═╝

This is a custom logger created for IQ applications. Just instantiate a logger class, set a partner, if necessary, and you're good to go!

Usage

const logger = new IqLogger();
logger.setPartner("iq-partner");

Logger Options

It's possible to setup the log level that will be emitted, this make possible implements all kind of logs and just configure wich one will be display depending on environment rules. Example:

import { IqLogger, LogLevel } from "iq-logger";
const logger = new IqLogger({logLevel: LogLevel.Warn});
logger.Info("Info message");
logger.Warn("Warn message");
OUTPUT: Warn message

If log level was not set, the default value is Info. Down below it's the available values organized ascending in restrition level

Log Level Restriction Value Comments
Debug 1 Used to log info about runtine
Info (default) 2 Used to log info about important points of the application
Warn 3 Used to log some warn that may cause an error
Error 4 Used to log an error
Debug log

Debug logs require an debug message, and can have an optional data parameter.

const data = {
  dataField: "data value"
};

logger.Debug("Debug message", data, additionalFields);
Info log

Info logs require an info message, and can have an optional data parameter, as well as additional custom parameters.

const data = {
  dataField: "data value"
};

const additionalFields = {
  customField: "customValue"
};

logger.Info("Info message", data, additionalFields);
Warn log

Warn logs require an warn message, and can have an optional data parameter, as well as additional custom parameters.

const data = {
  dataField: "data value"
};

const additionalFields = {
  customField: "customValue"
};

logger.Warn("Warn message", data, additionalFields);
Error log

Error logs take a Javascript Error instance and formats the stack trace and error message.

logger.Error(err: Error);