Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConsoleLogProvider

Hierarchy

  • LogProvider
    • ConsoleLogProvider

Index

Constructors

constructor

Methods

doLog

  • doLog(timestamp: DateTime, level: LogLevel, tag: string, message: string, ex?: Exception): void
  • Parameters

    • timestamp: DateTime
    • level: LogLevel
    • tag: string
    • message: string
    • Optional ex: Exception

    Returns void

Protected generateLogLine

  • generateLogLine(timestamp: DateTime, level: LogLevel, tag: string, message: string, ex: Exception): string
  • Generates a default log line.

    Parameters

    • timestamp: DateTime

      When the event occurred.

    • level: LogLevel

      The log level,

    • tag: string

      Which logger it came from.

    • message: string

      The log message.

    • ex: Exception

      The exception if one is available.

    Returns string

getFilter

  • getFilter(): IFunction2<string, LogLevel, boolean>
  • Gets a filter on the log provider.

    Returns IFunction2<string, LogLevel, boolean>

getLevel

  • getLevel(): LogLevel
  • Gets the log level.

    Returns LogLevel

getTypeString

  • getTypeString(): string

log

  • log(timestamp: DateTime, level: LogLevel, tag: string, message: string): void
  • log(timestamp: DateTime, level: LogLevel, tag: string, message: string, ex: Exception): void
  • Log a message with no exception.

    Parameters

    • timestamp: DateTime

      The timestamp when the event occurred.

    • level: LogLevel

      The level of log message.

    • tag: string

      The logger tag.

    • message: string

      The log message.

    Returns void

  • Log a message.

    Parameters

    • timestamp: DateTime

      The timestamp when the event occurred.

    • level: LogLevel

      The level of log message.

    • tag: string

      The logger tag.

    • message: string

      The log message.

    • ex: Exception

      The exception that occured.

    Returns void

setFilter

  • setFilter(value: IFunction2<string, LogLevel, boolean>): void
  • Sets a filter on the log provider.

    Parameters

    • value: IFunction2<string, LogLevel, boolean>

    Returns void

setLevel

  • setLevel(value: LogLevel): void
  • Sets the log level.

    Parameters

    • value: LogLevel

    Returns void

writeLine

  • writeLine(text: string): void
  • Parameters

    • text: string

    Returns void

Static Protected getPrefix

  • getPrefix(level: LogLevel): string
  • getPrefix(level: LogLevel, includeTimestamp: boolean): string
  • Converts a log-level to a 5-character string for consistently-spaced character sequences.

    Parameters

    • level: LogLevel

      The log level.

    Returns string

    The log level as an upper-case string with right-side whitespace padding to ensure a 5-character sequence.

  • Converts a log-level to a 5-character string for consistently-spaced character sequences.

    Parameters

    • level: LogLevel

      The log level.

    • includeTimestamp: boolean

      Whether to include a timestamp in the prefix.

    Returns string

    The log level as an upper-case string with right-side whitespace padding to ensure a 5-character sequence.

Static getPrefixTimestamp

  • getPrefixTimestamp(timestamp: DateTime): string
  • Converts a timestamp to a string formatted for rendering in a log message (yyyy/MM/dd-hh:mm:ss).

    Parameters

    • timestamp: DateTime

      The timestamp.

    Returns string

    The timestamp as a formatted string.