Class DefaultLogger

Hierarchy (view full)

BaseLogger
- DefaultLogger
  - ConsoleLogger

Index

Constructors

Properties

Methods

debug error fatal info log verbose warn

Constructors

constructor

new DefaultLogger(stream, __namedParameters?): DefaultLogger
Creates an instance of Logger.
Parameters
- stream: Stream
- __namedParameters: ILoggerOptions = ...
Returns DefaultLogger
Memberof
Logger
Overrides BaseLogger.constructor
- Defined in DefaultLogger.ts:17

Properties

`Protected` `Readonly` stream

stream: Stream

Methods

debug

debug(message): void
Logs debug information to the console.
Parameters
- message: string
Returns void
Memberof
Logger
- Defined in DefaultLogger.ts:127

error

error(message): void
Logs an error to the console
Parameters
- message: string
Returns void
Memberof
Logger
- Defined in DefaultLogger.ts:103

fatal

fatal(message): void
Logs a fatal error to the console. When it occurs, it is good practice to kill the process afterwards.
Parameters
- message: string
Returns void
Memberof
Logger
- Defined in DefaultLogger.ts:95

info

info(message): void
Logs an information to the console
Parameters
- message: string
Returns void
Memberof
Logger
- Defined in DefaultLogger.ts:119

log

log(message, level, includeTimestamp?): void
Log a message to the console at the provided level. Include the timestamp if includeTimestamp is set.
Parameters
- message: string
  the message to log
- level: LogEventLevel
  the level to log the message at
- Optional includeTimestamp: boolean
  whether to log the message with the timestamp or not. Defaults to false.
Returns void
Memberof
Logger
- Defined in DefaultLogger.ts:33
log(message, localOptions): void
Log a message to the console based on the provided localOptions
Parameters
- message: string
  the message to log
- localOptions: ILoggerOptions
  the local options which are used by the logger
Returns void
Memberof
Logger
- Defined in DefaultLogger.ts:42

verbose

verbose(message): void
Logs everything in the console. Called verbose because it can be quite spammy.
Parameters
- message: string
Returns void
Memberof
Logger
- Defined in DefaultLogger.ts:136

warn

warn(message): void
Logs a warning to the console
Parameters
- message: string
Returns void
Memberof
Logger
- Defined in DefaultLogger.ts:111