Class Logger

The Logger class.

Index

Properties

Methods

debug error fatal info trace warn getLogger getOutputConfig init setBasicTimestampFormatter setFilter setFormatFunction setJsonFormatter setLevel setMessagesJoinFunction setTagsOutputVisibility setTimestampFormatter

Properties

name

name: string

tags

tags: string[]

Methods

debug

debug(...message: unknown[]): void
Logs debug message.
Parameters
- ...message: unknown[]
  The message(s) to be logged.
Returns void
- Defined in index.d.ts:2027

error

error(...message: unknown[]): void
Logs an error message.
Parameters
- ...message: unknown[]
  The error message(s) to log.
Returns void
- Defined in index.d.ts:2045

fatal

fatal(...message: unknown[]): void
Logs a fatal error.
Parameters
- ...message: unknown[]
  The error message to log.
Returns void
- Defined in index.d.ts:2051

info

info(...message: unknown[]): void
Logs an informational message.
Parameters
- ...message: unknown[]
  The message(s) to be logged.
Returns void
- Defined in index.d.ts:2033

trace

trace(...message: unknown[]): void
Logs a trace message.
Parameters
- ...message: unknown[]
  The message(s) to be logged.
Returns void
- Defined in index.d.ts:2021

warn

warn(...message: unknown[]): void
Logs a warning message.
Parameters
- ...message: unknown[]
  The warning message or messages to be logged.
Returns void
- Defined in index.d.ts:2039

`Static`getLogger

getLogger(name: string, ...tags: string[]): Logger
Returns a new Logger.
Parameters
- name: string
  The name of the Logger.
- ...tags: string[]
  The tags for the Logger as strings.
Returns Logger
A new Logger.
- Defined in index.d.ts:1993

`Static`getOutputConfig

getOutputConfig(): OutputConfig
Get the output configuration for the logger.

Returns OutputConfig
The output configuration.
- Defined in index.d.ts:1984

`Static`init

init(): void
Initialize logger class

Returns void
- Defined in index.d.ts:1941

`Static`setBasicTimestampFormatter

setBasicTimestampFormatter(): void
Set the basic timestamp formatter for the logger in HH:mm:ss.SS format.

Returns void
- Defined in index.d.ts:1974

`Static`setFilter

setFilter(filter: string[] | "*"): void
Filter the loggers by the given tags. Tags can use the * wildcard.
Parameters
- filter: string[] | "*"
  The filter to set.
Returns void
- Defined in index.d.ts:1950

`Static`setFormatFunction

setFormatFunction(
    func: (
        level: LogLevel,
        logger: Logger,
        message: string,
        timestamp: string,
        tags?: string[],
    ) => string,
): void
Set the format function for the logger.
Parameters
- func: (
      level: LogLevel,
      logger: Logger,
      message: string,
      timestamp: string,
      tags?: string[],
  ) => string
  The function to set.
Returns void
- Defined in index.d.ts:1955

`Static`setJsonFormatter

setJsonFormatter(formatter: ColorJSON): void
Set the JSON formatter for the logger.
Parameters
- formatter: ColorJSON
  The json formatter to set.
Returns void
- Defined in index.d.ts:1979

`Static`setLevel

setLevel(level: LogLevel): void
Parameters
- level: LogLevel
  The level to set.
Returns void
- Defined in index.d.ts:1945

`Static`setMessagesJoinFunction

setMessagesJoinFunction(func: (messages: string[]) => string): void
Set the function, that joins multiple messages into one for the logger.
Parameters
- func: (messages: string[]) => string
  The function to set.
Returns void
- Defined in index.d.ts:1960

`Static`setTagsOutputVisibility

setTagsOutputVisibility(visible: boolean): void
Set the tag visibility for the logger. When true, tags will be printed in the log. Disabled by default.
Parameters
- visible: boolean
Returns void
- Defined in index.d.ts:1965

`Static`setTimestampFormatter

setTimestampFormatter(formatter: (timestamp: Date) => string): void
Set the timestamp formatter for the logger.
Parameters
- formatter: (timestamp: Date) => string
  The function used to format the timestamp.
Returns void
- Defined in index.d.ts:1970