Class ConsoleLogger

The console logger class

Export

ConsoleLogger

Hierarchy (view full)

Constructors

constructor

Properties

stream

Methods

debug error fatal info log verbose warn

Constructors

constructor

Properties

Protected Readonly stream

stream: Stream

Methods

debug

error

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

info

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

  • 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

verbose

  • verbose(message): void

  • Logs everything in the console. Called verbose because it can be quite spammy.

    Parameters

    • message: string

    Returns void

    Memberof

    Logger

warn

Settings

Member Visibility

Theme

On This Page

constructorstreamdebugerrorfatalinfologverbosewarn