Class LogFormatter`Abstract`

This class defines and implements common methods for the formatting of log attributes.

Abstract

Implements

Hierarchy

LogFormatter
- PowertoolLogFormatter
- PowertoolLogFormatter

Implements

LogFormatterInterface

Index

Constructors

Methods

formatAttributes formatError formatTimestamp getCodeLocation

Constructors

constructor

new LogFormatter(): LogFormatter
Returns LogFormatter

Methods

`Abstract` formatAttributes

formatAttributes(attributes): LogAttributes
It formats key-value pairs of log attributes.
Parameters
- attributes: UnformattedAttributes
Returns LogAttributes
Implementation of LogFormatterInterface.formatAttributes
- Defined in logger/src/formatter/LogFormatter.ts:35

formatError

formatError(error): LogAttributes
It formats a given Error parameter.
Parameters
- error: Error
Returns LogAttributes
Implementation of LogFormatterInterface.formatError
- Defined in logger/src/formatter/LogFormatter.ts:45

formatTimestamp

formatTimestamp(now): string
It formats a date into a string in simplified extended ISO format (ISO 8601).
Parameters
- now: Date
Returns string
- Defined in logger/src/formatter/LogFormatter.ts:65

getCodeLocation

getCodeLocation(stack?): string
It returns a string containing the location of an error, given a particular stack trace.
Parameters
- Optional stack: string
Returns string
- Defined in logger/src/formatter/LogFormatter.ts:75

Generated using TypeDoc