Interface DueLog

A message about to be logged.

Such message can be additionally processed before it is written to the log.

Hierarchy

  • DueLog

Properties

Properties

index: number

An index of currently processed element of the log line.

Can be modified to specify the next element to process.

line: unknown[]

Log line to process and log.

Can be modified or replaced to change the message to log.

on?: string

A hint indicating the logging stage.

A log processor may wish to conditionally process the message depending on the stage.

Possible values are:

  • 'in' - input stage. Set for the logger input. I.e., for the log line passed to the logger method.
  • 'out' - output stage. Set by log writer. I.e., right before the message written to the log.
  • undefined - default stage. When set, the value should be processed unconditionally.

Some logger implementations may wish to use this hint for special processing. If the stage is not recognized by the loggable value, then it is generally means no processing should be performed.

Generated using TypeDoc