Class JLogger

Json Logger objact. Do not use this class directly; always create an instance of JLogger using LoggerFactory

Hierarchy

JLogger

Index

Constructors

Properties

Methods

debug error info log logWritten panic warn

Constructors

constructor

new JLogger(name: string, logLevel?: LogLevel): JLogger
Parameters
- name: string
- Optional logLevel: LogLevel
Returns JLogger
- Defined in logger.ts:41

Properties

`Optional` `Readonly` logLevel

logLevel?: LogLevel

Methods

debug

debug(message: TLoggerMessageType, ...rest: TLoggableEntry[]): void
Write a DEBUG severity log
Parameters
- message: TLoggerMessageType
- Rest ...rest: TLoggableEntry[]
Returns void
- Defined in logger.ts:204

error

error(message: TLoggerMessageType, ...rest: TLoggableEntry[]): void
Write a ERROR severity log
Parameters
- message: TLoggerMessageType
- Rest ...rest: TLoggableEntry[]
Returns void
- Defined in logger.ts:219

info

info(message: TLoggerMessageType, ...rest: TLoggableEntry[]): void
Write a INFO severity log
Parameters
- message: TLoggerMessageType
- Rest ...rest: TLoggableEntry[]
Returns void
- Defined in logger.ts:209

`Protected` log

log(severity: string, message: TLoggerMessageType, ...rest: TLoggableEntry[]): void
The main logging method that actually write to the log. The objective is to allow caller to pass only Error object as a log, as well as supporting the case where a log contains both the message and Error object. The message attribute must never be undefined.
Parameters
- severity: string
- message: TLoggerMessageType
  
  string or instance of Error
- Rest ...rest: TLoggableEntry[]
Returns void
- Defined in logger.ts:165

logWritten

logWritten(maxRetry?: number): Promise<void>
If a async destination based on AbstractAsyncLogDestination exists, use this method to wait for last log call complete.

Returns
Parameters
- maxRetry: number = 20
  
  number of time to retry. Default to retry for 20 times.
Returns Promise<void>
- Defined in logger.ts:235

panic

panic(message: TLoggerMessageType, ...rest: TLoggableEntry[]): void
Write a PANIC severity log
Parameters
- message: TLoggerMessageType
- Rest ...rest: TLoggableEntry[]
Returns void
- Defined in logger.ts:224

warn

warn(message: TLoggerMessageType, ...rest: TLoggableEntry[]): void
Write a WARNING severity log
Parameters
- message: TLoggerMessageType
- Rest ...rest: TLoggableEntry[]
Returns void
- Defined in logger.ts:214

Generated using TypeDoc