0.0.8 • Published 2 years ago

@tmz-js/logger v0.0.8

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

Logger

How to use

As early as possible import logger and Init:

import logger from '@tmz-js/logger';
logger.init({serviceName: nameOfService, level: logger.LogLevel.info});

init can receive the following options:

ParameterOptionalDefaultDescription
serviceNameV'anonymous'name of service
levelV'warn'log level (use LogLevel Enum)
keepAliveIntervalV5000Keep alive time in ms
verboseVFalsePrint all logs
silentVFalseStop the printing of all logs
prettifyVFalsePrettify all logs
includeServiceNameVFalseShould service name be logged
escapeJsonVTrueShould output JSON be escaped

anywhere in your service where you would wish to log you can import logger and log as follows:

logger.log(
    ${log level},
    ${message},
    ${meta data object}  #optional
)

Example1:

logger.log(
    logger.LogLevel.warn,
    'somthing went teribly wrong'
)

Example2:

logger.log(
    logger.LogLevel.warn,
    'somthing went teribly wrong',
    {
        userID: 'some user id'
    }
)

You can also use one of the following methods to log:

  • error
  • warn
  • info
  • http
  • verbose
  • debug
  • silly

Example:

logger.info('this is very informing information');

If your service contains multiple modules you may wish to create a separate logger for each module. Example:

import Logger from '@tmz-js/logger';
const logger = Logger.getLogger('amazing logger');
logger.info('information');
  • note: even when using modules you should initialize the logger as soon as possible.
0.0.8

2 years ago

0.0.5

2 years ago

0.0.4

2 years ago

0.0.7

2 years ago

0.0.6

2 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.1

3 years ago