Class Logger

The Logger class provides access to the methods for logging messages at the required Level.

Typically, each component or service will instantiate its own Logger instance, which will include the logger's Logger.name in the logged message.

Index

Constructors

constructor

new Logger(name: string, _logService: LogService): Logger
Internal
Instantiates a new Logger.

Logger instances should NOT be instantiated directly using this constructor as the instance will not be registered and cached within the LogService. (This will mean that every instance of the parent class will end up with its own duplicate copy, rather than sharing a single instance.) Instead, use the LogService.getLogger() method, i.e.
```
   this._log = logService.getLogger('MyComponent');
```
Parameters
- name: string
- _logService: LogService
Returns Logger
- Defined in lib/logger.ts:27

Properties

`Readonly`name

name: string

A name, usually that of the 'parent' component, that will be logged with each message.

Methods

assert

assert(condition: undefined | boolean, message: string): void
Logs the message if condition is false.

The log entry is recorded as Level.error.
Parameters
- condition: undefined | boolean
  A boolean value or statement that determines if the message is logged or not.
- message: string
  The text message to be logged.
Returns void
- Defined in lib/logger.ts:42
assert(condition: undefined | boolean, error: Error): void
Logs the message if condition is false.

The log entry is recorded as Level.error.
Parameters
- condition: undefined | boolean
  A boolean value or statement that determines if the message is logged or not.
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:51
assert(condition: undefined | boolean, message: string, error: Error): void
Logs the message if condition is false.

The log entry is recorded as Level.error.
Parameters
- condition: undefined | boolean
  A boolean value or statement that determines if the message is logged or not.
- message: string
  The text message to be logged.
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:61
assert(condition: undefined | boolean, message: string, data: object): void
Logs the message if condition is false.

The log entry is recorded as Level.error.
Parameters
- condition: undefined | boolean
  A boolean value or statement that determines if the message is logged or not.
- message: string
- data: object
  An object to be logged.
Returns void
- Defined in lib/logger.ts:70

debug

debug(message: string): void
Logs the message as Level.debug.
Parameters
- message: string
  The text message to be logged.
Returns void
- Defined in lib/logger.ts:82
debug(error: Error): void
Logs the message as Level.debug.
Parameters
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:88
debug(message: string, error: Error): void
Logs the message as Level.debug.
Parameters
- message: string
  The text message to be logged.
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:95
debug(message: string, data: object): void
Logs the message as Level.debug.
Parameters
- message: string
  The text message to be logged.
- data: object
  An object to be logged.
Returns void
- Defined in lib/logger.ts:102

error

error(message: string): void
Logs the message as Level.error.
Parameters
- message: string
  The text message to be logged.
Returns void
- Defined in lib/logger.ts:172
error(error: Error): void
Logs the message as Level.error.
Parameters
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:178
error(message: string, error: Error): void
Logs the message as Level.error.
Parameters
- message: string
  The text message to be logged.
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:185
error(message: string, data: object): void
Logs the message as Level.error.
Parameters
- message: string
  The text message to be logged.
- data: object
  An object to be logged.
Returns void
- Defined in lib/logger.ts:192

fatal

fatal(message: string): void
Logs the message as Level.fatal.
Parameters
- message: string
  The text message to be logged.
Returns void
- Defined in lib/logger.ts:202
fatal(error: Error): void
Logs the message as Level.fatal.
Parameters
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:208
fatal(message: string, error: Error): void
Logs the message as Level.fatal.
Parameters
- message: string
  The text message to be logged.
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:215
fatal(message: string, data: object): void
Logs the message as Level.fatal.
Parameters
- message: string
  The text message to be logged.
- data: object
  An object to be logged.
Returns void
- Defined in lib/logger.ts:222

info

info(message: string): void
Logs the message as Level.info.
Parameters
- message: string
  The text message to be logged.
Returns void
- Defined in lib/logger.ts:112
info(error: Error): void
Logs the message as Level.info.
Parameters
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:118
info(message: string, error: Error): void
Logs the message as Level.info.
Parameters
- message: string
  The text message to be logged.
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:125
info(message: string, data: object): void
Logs the message as Level.info.
Parameters
- message: string
  The text message to be logged.
- data: object
  An object to be logged.
Returns void
- Defined in lib/logger.ts:132

log

log(levelName: string, message: string): void
Logs the message as the specified level.
Parameters
- levelName: string
  The name of the level.
- message: string
  The text message to be logged.
  
  If no Level has been defined for the specified levelName, the message will be ignored.
Returns void
- Defined in lib/logger.ts:235
log(levelName: string, error: Error): void
Logs the message as the specified level.
Parameters
- levelName: string
  The name of the level.
- error: Error
  An Error object to be logged.
  
  If no Level has been defined for the specified levelName, the message will be ignored.
Returns void
- Defined in lib/logger.ts:244
log(levelName: string, message: string, error: Error): void
Logs the message as the specified level.
Parameters
- levelName: string
  The name of the level.
- message: string
  The text message to be logged.
- error: Error
  An Error object to be logged.
  
  If no Level has been defined for the specified levelName, the message will be ignored.
Returns void
- Defined in lib/logger.ts:254
log(levelName: string, message: string, data: object): void
Logs the message as the specified level.
Parameters
- levelName: string
  The name of the level.
- message: string
  The text message to be logged.
- data: object
  An object to be logged.
  
  If no Level has been defined for the specified levelName, the message will be ignored.
Returns void
- Defined in lib/logger.ts:264

warn

warn(message: string): void
Logs the message as Level.warn.
Parameters
- message: string
  The text message to be logged.
Returns void
- Defined in lib/logger.ts:142
warn(error: Error): void
Logs the message as Level.warn.
Parameters
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:148
warn(message: string, error: Error): void
Logs the message as Level.warn.
Parameters
- message: string
  The text message to be logged.
- error: Error
  An Error object to be logged.
Returns void
- Defined in lib/logger.ts:155
warn(message: string, data: object): void
Logs the message as Level.warn.
Parameters
- message: string
  The text message to be logged.
- data: object
  An object to be logged.
Returns void
- Defined in lib/logger.ts:162

Class Logger

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Logger

Properties

Readonlyname

Methods

assert

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

debug

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

error

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

fatal

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

info

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

log

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

warn

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

Settings

On This Page

`Readonly`name