Class Logger

Hierarchy

Logger

Index

Constructors

constructor

Properties

className

Methods

Constructors

constructor

new Logger(className: string, options?: LoggerOptions): Logger

- Defined in src/logger.ts:44
Creates a new Logger instance

Parameters
- className: string
  
  The Class name associated with the logging instance
- Optional options: LoggerOptions
  
  Optional logging settings
Returns Logger

Properties

className

className: string

Methods

debug

debug(message: string, object?: unknown): void

- Defined in src/logger.ts:80
Log a message at the debug level

Parameters
- message: string
  
  The message to log
- Optional object: unknown
  
  Additional meta data to log
Returns void

error

error(message: string, object?: unknown): void

- Defined in src/logger.ts:161
Log a message at the error level

Parameters
- message: string
  
  The message to log
- Optional object: unknown
  
  Additional meta data to log
Returns void

info

info(message: string, object?: unknown): void

- Defined in src/logger.ts:134
Log a message at the info level

Parameters
- message: string
  
  The message to log
- Optional object: unknown
  
  Additional meta data to log
Returns void

isDebug

isDebug(): boolean

- Defined in src/logger.ts:203
Is the logger set at debug level

Returns boolean

isError

isError(): boolean

- Defined in src/logger.ts:188
Is the logger set at error level

Returns boolean

isInfo

isInfo(): boolean

- Defined in src/logger.ts:183
Is the logger set at info level

Returns boolean

isWarn

isWarn(): boolean

- Defined in src/logger.ts:193
Is the logger set at error level

Returns boolean

warn

warn(message: string, object?: unknown): void

- Defined in src/logger.ts:107
Log a message at the warn level

Parameters
- message: string
  
  The message to log
- Optional object: unknown
  
  Additional meta data to log
Returns void

Static currentLogger

currentLogger(): LoggerFunction

- Defined in src/logger.ts:214
Get the current logger function

Returns LoggerFunction

Static filter

filter(type: string, values: string[]): void

- Defined in src/logger.ts:237
Filter log messages for a particular class

Parameters
- type: string
  
  The type of filter (currently only class)
- values: string[]
  
  The filters to apply
Returns void

Static reset

reset(): void

- Defined in src/logger.ts:208
Resets the logger to default settings, error and no filtered classes

Returns void

Static setCurrentLogger

setCurrentLogger(logger: LoggerFunction): void

- Defined in src/logger.ts:223
Set the current logger function

Parameters
- logger: LoggerFunction
  
  Custom logging function
Returns void

Static setLevel

setLevel(newLevel: LoggerLevel): void

- Defined in src/logger.ts:249
Set the current log level

Parameters
- newLevel: LoggerLevel
  
  Set current log level (debug, warn, info, error)
Returns void

Generated using TypeDoc