Class Logger

The Logger class.

Hierarchy

Logger

Index

Constructors

Properties

log logRaw name tags initialized

Methods

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

Constructors

`Private` constructor

new Logger(): Logger
Construct a new Logger

Returns Logger
- Defined in index.d.ts:814

Properties

`Private` log

log: any

Log messages with the level set.

Param

The LogLevel to log the messages at.

Param

An array of the messages to log.

`Private` logRaw

logRaw: any

Internal function to log messages with the level set, that bypasses the filters.

Param

The LogLevel to log the messages at.

Param

An array of the messages to log.

name

name: string

tags

tags: string[]

`Static` `Private` initialized

initialized: any

Methods

debug

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

error

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

fatal

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

info

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

trace

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

warn

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

`Static` getLogger

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

`Static` getOutputConfig

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

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

`Static` init

init(): void
Initialize logger class

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

`Static` setFilter

setFilter(filter): 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:773

`Static` setFormatFunction

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

`Static` setJsonFormatter

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

`Static` setLevel

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

`Static` setMessagesJoinFunction

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

`Static` setTagsOutputVisibility

setTagsOutputVisibility(visible): 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:788