Class LogEvent

Base class for values that get generated by Logger instances.

NOTE: this class should be considered read-only, and its fields should not be mutated directly. The caching system in this module expects that event instances will not be mutated by external sources.

Hierarchy

  • LogEvent

Implements

Constructors

constructor

Properties

level message params tag timestamp

Methods

clone getMessageWithParams initialize toString stringify

Constructors

constructor

  • Parameters

    • level: number
    • tag: string
    • message: string
    • Optional params: any[]
    • Optional timestamp: number

    Returns LogEvent

Properties

level

level: number

message

message: string

params

params: undefined | any[]

tag

tag: string

timestamp

timestamp: number

Methods

clone

  • Make a copy of this instance. Useful if you want to buffer events without disabling event caching at the transport level.

    Returns LogEvent

getMessageWithParams

  • See stringifyAndJoin for argument details.

    Parameters

    • Optional parameterSeparator: string
    • Optional stringifyMaxLength: number

    Returns string

initialize

  • Used by the caching system to recycle existing event instances. It is not recommended to use this directly.

    Parameters

    • level: number
    • tag: string
    • message: string
    • params: undefined | any[] = undefined
    • timestamp: number = ...

    Returns void

toString

  • Parameters

    • Optional ignoreParams: boolean
    • Optional levelNameMap: LogLevelNameMap
    • Optional parameterSeparator: string
    • Optional stringifyMaxLength: number

    Returns string

Static stringify

  • Convenience api akin to JSON.stringify().

    Parameters

    • ev: LogEventLike
    • Optional ignoreParams: boolean
    • Optional levelNameMap: LogLevelNameMap
    • Optional parameterSeparator: string
    • Optional stringifyMaxLength: number

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc