Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Logging

A singleton service that manages loggers registered in the application, and can be used to log output to all of them based on the configured logging level.

This should be used in place of console.log as it also supports logging to external locations.

example
logging.info('Info level!')
logging.debug('Some debugging information...')
logging.warn('A warning!', true)  // true, to force it to show, regardless of logging level.

Hierarchy

  • Logging

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected currentLevel

currentLevel: LoggingLevel = ...

The currently configured logging level.

Protected registeredLoggers

registeredLoggers: Logger[] = []

Array of Logger implementations that should be logged to.

Accessors

level

Methods

Protected buildMessage

debug

  • debug(output: unknown, force?: boolean): void

  • Write a debugging-level output to the logs.

    Parameters

    • output: unknown
    • force: boolean = false

      if true, output even if outside the current logging level

    Returns void

error

  • error(output: unknown, force?: boolean): void

  • Write an error-level output to the logs.

    Parameters

    • output: unknown
    • force: boolean = false

      if true, output even if outside the current logging level

    Returns void

Protected getCallerInfo

  • getCallerInfo(level?: number): string

  • Get the name of the object that called the log method using error traces.

    Parameters

    • level: number = 5

    Returns string

info

  • info(output: unknown, force?: boolean): void

  • Write an info-level output to the logs.

    Parameters

    • output: unknown
    • force: boolean = false

      if true, output even if outside the current logging level

    Returns void

registerLogger

success

  • success(output: unknown, force?: boolean): void

  • Write a success-level output to the logs.

    Parameters

    • output: unknown
    • force: boolean = false

      if true, output even if outside the current logging level

    Returns void

unregisterLogger

verbose

  • verbose(output: unknown, force?: boolean): void

  • Write a verbose-level output to the logs.

    Parameters

    • output: unknown
    • force: boolean = false

      if true, output even if outside the current logging level

    Returns void

warn

  • warn(output: unknown, force?: boolean): void

  • Write a warning-level output to the logs.

    Parameters

    • output: unknown
    • force: boolean = false

      if true, output even if outside the current logging level

    Returns void

Protected writeLog

  • writeLog(level: LoggingLevel, output: unknown, force?: boolean): void

  • Helper function to write the given output, at the given logging level, to all of the registered loggers.

    Parameters

    • level: LoggingLevel
    • output: unknown
    • force: boolean = false

      if true, output even if outside the current logging level

    Returns void

Extollo Logo

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.