Class LogFormatter`Abstract`

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

Abstract

Implements

Hierarchy

LogFormatter
- PowertoolLogFormatter

Implements

LogFormatterInterface

Index

Constructors

Methods

formatAttributes formatError formatTimestamp getCodeLocation

Constructors

constructor

new LogFormatter(): LogFormatter
Returns LogFormatter

Methods

`Abstract` formatAttributes

formatAttributes(attributes: UnformattedAttributes): LogAttributes
It formats key-value pairs of log attributes.

Returns
Parameters
- attributes: UnformattedAttributes
Returns LogAttributes
Implementation of LogFormatterInterface.formatAttributes
- Defined in logger/src/formatter/LogFormatter.ts:18

formatError

formatError(error: Error): LogAttributes
It formats a given Error parameter.

Returns
Parameters
- error: Error
Returns LogAttributes
Implementation of LogFormatterInterface.formatError
- Defined in logger/src/formatter/LogFormatter.ts:28

formatTimestamp

formatTimestamp(now: Date): string
It formats a date into a string in simplified extended ISO format (ISO 8601).

Returns
Parameters
- now: Date
Returns string
- Defined in logger/src/formatter/LogFormatter.ts:43

getCodeLocation

getCodeLocation(stack?: string): string
It returns a string containing the location of an error, given a particular stack trace.

Returns
Parameters
- Optional stack: string
Returns string
- Defined in logger/src/formatter/LogFormatter.ts:53

Generated using TypeDoc