Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LogEvent

LogEvent is a simple data class used to pass information from an application's Logger to registered event-listeners when a log event occurs. A log event is triggered when a message is added to the log via debug(), info(), warn(), error, or fatal(). The LogEvent class also defines a constant representing the log events: LogEvent.UPDATE and LogEvent.LEVEL_CHANGE.

To register for a log event, use the Logger.addEventListener method.

Hierarchy

  • Event
    • LogEvent

Index

Constructors

constructor

  • new LogEvent(type: string, message?: undefined | string, level?: undefined | string, timeStamp?: undefined | string): LogEvent
  • Parameters

    • type: string
    • Optional message: undefined | string
    • Optional level: undefined | string
    • Optional timeStamp: undefined | string

    Returns LogEvent

Properties

Optional target

target: EventDispatcher

type

type: string

Static LEVEL_CHANGE

LEVEL_CHANGE: string = "LEVEL_CHANGE"

Dispatched when the log's level is changed via Logger.setLevel method. To access the new level, use getLevel(), which returns one of the following values: Logger.FATAL, Logger.ERROR, Logger.WARN, Logger.INFO, or Logger.DEBUG.

Static UPDATE

UPDATE: string = "UPDATE"

Dispatched when a new message is added to the log. To add a message to the log, use one of the following Logger class methods: debug(), info(), warn(), error(), or fatal().

Methods

getLevel

  • getLevel(): string | null
  • If this event is LogEvent.UPDATE, returns the severity level for the log entry; if this event is LogEvent.LEVEL_CHANGE, returns the log's new severity level.

    Returns string | null

    One of Logger.FATAL, Logger.ERROR, Logger.WARN, Logger.INFO, or Logger.DEBUG.

getMessage

  • getMessage(): string | null
  • Returns the text of the log message. Available for the LogEvent.UPDATE event only.

    Returns string | null

getTimeStamp

  • getTimeStamp(): string | null
  • Returns a human-readable string indicating the time of the log entry.

    Returns string | null

toString

  • toString(): string
  • Returns string