Class default

ILogger interface for all logging implementations

Hierarchy

default

Implements

Index

Constructors

Properties

#disposed #logger #name _scope closeScope openScope

Methods

#ensureNotDisposed #prepareMessage debug debugError dispose error errorError info infoError scope trace traceError warn warnError isScopedLogger

Constructors

constructor

new default(logger, name): default
Parameters
- logger: ILogger
- name: string
Returns default
- Defined in src/Logging/ScopedLogger.ts:16

Properties

`Private` #disposed

#disposed: boolean = false

`Private` `Readonly` #logger

#logger: ILogger

`Private` `Readonly` #name

#name: string

`Private` `Readonly` _scope

_scope: string[]

`Static` closeScope

closeScope: string = ']'

`Static` openScope

openScope: string = '['

Methods

`Private` #ensureNotDisposed

#ensureNotDisposed(): void
Returns void
- Defined in src/Logging/ScopedLogger.ts:112

`Private` #prepareMessage

#prepareMessage(msg?): string
Parameters
- Optional msg: string
Returns string
- Defined in src/Logging/ScopedLogger.ts:107

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/ScopedLogger.ts:35

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/ScopedLogger.ts:41

dispose

dispose(): void
Returns void
Implementation of IDisposable.dispose
- Defined in src/Logging/ScopedLogger.ts:101

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/ScopedLogger.ts:47

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/ScopedLogger.ts:53

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/ScopedLogger.ts:59

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/ScopedLogger.ts:65

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/ScopedLogger.ts:95

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/ScopedLogger.ts:71

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/ScopedLogger.ts:77

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/ScopedLogger.ts:83

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/ScopedLogger.ts:89

`Static` isScopedLogger

isScopedLogger<T>(subject): subject is default
Type Parameters
- T
Parameters
- subject: default | T
Returns subject is default
- Defined in src/Logging/ScopedLogger.ts:30

Generated using TypeDoc