Options
All
  • Public
  • Public/Protected
  • All
Menu

Logger with colors, loglevel and transport

Log level can be defined by setting the environment variable STAPPS_LOG_LEVEL to a valid log level. Log levels are set in a binary way. For example STAPPS_LOG_LEVEL=12 does result in logs only for Logger.warn and Logger.error.

Log levels in that order are:

1 - INFO
2 - LOG
4 - WARN
8 - ERROR
16 - OK

Hierarchy

  • Logger

Index

Constructors

constructor

  • Instatiate an instance of logger

    Parameters

    • Optional transport: Transport

      A transport instance that can be used for error transport

    Returns Logger

Properties

Private checkLogLevel

checkLogLevel: any

Check if intended log level is allowed in environment log level

param
returns

Private cyan

cyan: any

Prefix for cyan color

Private getLogLevel

getLogLevel: any

Return log level from environment

returns

Private green

green: any

Prefix for green color

Private isNode

isNode: any

Set to true if this code is executed by Node.js

Private isProductiveEnvironment

isProductiveEnvironment: any

Set to true if the environment for a productive environment is given

In Node.js this means that NODE_ENV is set to production

Private isTransportWithVerification

isTransportWithVerification: any

Private logLevels

logLevels: any

Log levels

Private red

red: any

Prefix for red color

Private reset

reset: any

Suffix to end a color

Private stringifyArguments

stringifyArguments: any

Stringify a list of arguments

param

Arguments to stringify

returns

Stringified arguments

Private Optional transport

transport: any

Transport for errors

For example @stapps/smtp-transport

Private white

white: any

Prefix for white color

Private yellow

yellow: any

Prefix for yellow color

Methods

error

  • error(...args: any[]): void
  • Log with level ERROR

    Parameters

    • Rest ...args: any[]

      Arguments to log

    Returns void

info

  • info(...args: any[]): void
  • Log with level INFO

    Parameters

    • Rest ...args: any[]

      Arguments to log

    Returns void

log

  • log(...args: any[]): void
  • Log with level LOG

    Parameters

    • Rest ...args: any[]

      Arguments to log

    Returns void

ok

  • ok(...args: any[]): void
  • Log with level OK

    Parameters

    • Rest ...args: any[]

      Arguments to log

    Returns void

warn

  • warn(...args: any[]): void
  • Log with level WARN

    Parameters

    • Rest ...args: any[]

      Arguments to log

    Returns void

Static isNodeEnvironment

  • isNodeEnvironment(): boolean
  • Checks if this code is executed in Node.js

    Returns boolean

Static isProductiveEnvironment

  • isProductiveEnvironment(): boolean
  • Checks if a productive environment is given

    Returns boolean

Generated using TypeDoc