Class default`Abstract`

ILogger interface for all logging implementations

Hierarchy

default

Implements

ILogger

Index

Constructors

constructor

new default(config?): default
Parameters
- config: ILoggerConfig = defaultConfig
Returns default
- Defined in src/Logging/Logger.ts:18

Properties

`Private` `Readonly` #config

#config: ILoggerConfig

`Static` closeLevel

closeLevel: string = ']'

`Static` openLevel

openLevel: string = '['

Methods

`Protected` `Abstract` _debugMethod

_debugMethod(message, ...args): void
Implementation for a Log message flagged at the Debug log level
Parameters
- message: string
- Rest ...args: unknown[]
  extra objects/values to include with the log message
Returns void
- Defined in src/Logging/Logger.ts:148

`Protected` `Abstract` _defaultMethod

_defaultMethod(message, ...args): void
Implementation for a Log message not flagged
Parameters
- message: string
- Rest ...args: unknown[]
  extra objects/values to include with the log message
Returns void
- Defined in src/Logging/Logger.ts:154

`Protected` `Abstract` _errorMethod

_errorMethod(message, ...args): void
Implementation for a Log message flagged at the Error log level
Parameters
- message: string
- Rest ...args: unknown[]
  extra objects/values to include with the log message
Returns void
- Defined in src/Logging/Logger.ts:124

`Protected` `Abstract` _infoMethod

_infoMethod(message, ...args): void
Implementation for a Log message flagged at the Informational log level
Parameters
- message: string
- Rest ...args: unknown[]
  extra objects/values to include with the log message
Returns void
- Defined in src/Logging/Logger.ts:136

`Protected` `Abstract` _traceMethod

_traceMethod(message, ...args): void
Implementation for a Log message flagged at the Trace log level
Parameters
- message: string
- Rest ...args: unknown[]
  extra objects/values to include with the log message
Returns void
- Defined in src/Logging/Logger.ts:142

`Protected` `Abstract` _warnMethod

_warnMethod(message, ...args): void
Implementation for a Log message flagged at the Warning log level
Parameters
- message: string
- Rest ...args: unknown[]
  extra objects/values to include with the log message
Returns void
- Defined in src/Logging/Logger.ts:130

debug

debug(msg, ...args): void
Log a message flagged at the Debug log level
Parameters
- msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.debug
- Defined in src/Logging/Logger.ts:23

debugError

debugError(err, msg?, ...args): void
Log an error flagged at the Debug log level
Parameters
- err: Error
- Optional msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.debugError
- Defined in src/Logging/Logger.ts:28

error

error(msg, ...args): void
Log a message flagged at the Error log level
Parameters
- msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.error
- Defined in src/Logging/Logger.ts:33

errorError

errorError(err, msg?, ...args): void
Log an error flagged at the Error log level
Parameters
- err: Error
- Optional msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.errorError
- Defined in src/Logging/Logger.ts:38

info

info(msg, ...args): void
Log a message flagged at the Informational log level
Parameters
- msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.info
- Defined in src/Logging/Logger.ts:43

infoError

infoError(err, msg?, ...args): void
Log an error flagged at the Informational log level
Parameters
- err: Error
- Optional msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.infoError
- Defined in src/Logging/Logger.ts:48

`Private` log

log(level, msg, ...args): void
Calls the implementation of the logging level
Parameters
- level: LogLevel
- msg: string
- Rest ...args: unknown[]
  extra objects/values to include with the log message
Returns void
- Defined in src/Logging/Logger.ts:84

scope

scope(name): ILogger & IDisposable
Rescope the logger with the provided name. Used for tagging the logger.
Parameters
- name: string
  The tag the logger should be given
Returns ILogger & IDisposable
Example
```
Use the scope tool inside a 'using' to scope logging to a specific method.
return using(() => logger.scope("theNameOfMyScope"), logger =>
 {
     logger.debug("Log something here");
 });
```
Implementation of ILogger.scope
- Defined in src/Logging/Logger.ts:73

trace

trace(msg, ...args): void
Log a message flagged at the Trace log level
Parameters
- msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.trace
- Defined in src/Logging/Logger.ts:53

traceError

traceError(err, msg?, ...args): void
Log an error flagged at the Trace log level
Parameters
- err: Error
- Optional msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.traceError
- Defined in src/Logging/Logger.ts:58

warn

warn(msg, ...args): void
Log a message flagged at the Warning log level
Parameters
- msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.warn
- Defined in src/Logging/Logger.ts:63

warnError

warnError(err, msg?, ...args): void
Log an error flagged at the Warning log level
Parameters
- err: Error
- Optional msg: string
- Rest ...args: unknown[]
Returns void
Implementation of ILogger.warnError
- Defined in src/Logging/Logger.ts:68

Class defaultAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: ILoggerConfig = defaultConfig

Returns default

Properties

Private Readonly #config

Static closeLevel

Static openLevel

Methods

Protected Abstract _debugMethod

Parameters

message: string

Rest ...args: unknown[]

Returns void

Protected Abstract _defaultMethod

Parameters

message: string

Rest ...args: unknown[]

Returns void

Protected Abstract _errorMethod

Parameters

message: string

Rest ...args: unknown[]

Returns void

Protected Abstract _infoMethod

Parameters

message: string

Rest ...args: unknown[]

Returns void

Protected Abstract _traceMethod

Parameters

message: string

Rest ...args: unknown[]

Returns void

Protected Abstract _warnMethod

Parameters

message: string

Rest ...args: unknown[]

Returns void

debug

Parameters

msg: string

Rest ...args: unknown[]

Returns void

debugError

Parameters

err: Error

Optional msg: string

Rest ...args: unknown[]

Returns void

error

Parameters

msg: string

Rest ...args: unknown[]

Returns void

errorError

Parameters

err: Error

Optional msg: string

Rest ...args: unknown[]

Returns void

info

Parameters

msg: string

Rest ...args: unknown[]

Returns void

infoError

Parameters

err: Error

Optional msg: string

Rest ...args: unknown[]

Returns void

Class default`Abstract`

`Private` `Readonly` #config

`Static` closeLevel

`Static` openLevel

`Protected` `Abstract` _debugMethod

`Rest` ...args: unknown[]

`Protected` `Abstract` _defaultMethod

`Rest` ...args: unknown[]

`Protected` `Abstract` _errorMethod

`Rest` ...args: unknown[]

`Protected` `Abstract` _infoMethod

`Rest` ...args: unknown[]

`Protected` `Abstract` _traceMethod

`Rest` ...args: unknown[]

`Protected` `Abstract` _warnMethod

`Rest` ...args: unknown[]

`Rest` ...args: unknown[]

`Optional` msg: string

`Rest` ...args: unknown[]

`Rest` ...args: unknown[]

`Optional` msg: string

`Rest` ...args: unknown[]

`Rest` ...args: unknown[]

`Optional` msg: string

`Rest` ...args: unknown[]

`Private` log

`Rest` ...args: unknown[]

`Rest` ...args: unknown[]

`Optional` msg: string

`Rest` ...args: unknown[]

`Rest` ...args: unknown[]

`Optional` msg: string

`Rest` ...args: unknown[]