Class Logger`Abstract`

A logger accepts messages from different levels and emits them in a certain way.

Hierarchy (View Summary)

Logger

Index

Constructors

Properties

activeLogGroups groupedLogLimit repetitionCounter LEVELS

Methods

debug error fatal flush info logGrouped trace warn getLevelOrdinal

Constructors

constructor

new Logger(): Logger
Returns Logger

Properties

`Protected` `Readonly`activeLogGroups

activeLogGroups: Record<
string,
{ callback: (count: number) => void; count: number; lastSeenIndex: number },
> = {}

`Protected` `Readonly`groupedLogLimit

groupedLogLimit: 5

`Protected`repetitionCounter

repetitionCounter: number = 0

`Static` `Readonly`LEVELS

LEVELS: Record<string, number> = ...

All available logging levels.

Methods

`Abstract`debug

debug(message: string, data?: any): void
Parameters
- message: string
- Optionaldata: any
Returns void
- Defined in packages/types/lib/Logger.ts:40

`Abstract`error

error(message: string, data?: any): void
Parameters
- message: string
- Optionaldata: any
Returns void
- Defined in packages/types/lib/Logger.ts:43

`Abstract`fatal

fatal(message: string, data?: any): void
Parameters
- message: string
- Optionaldata: any
Returns void
- Defined in packages/types/lib/Logger.ts:44

flush

flush(): void
Flush all active log groups.

Returns void
- Defined in packages/types/lib/Logger.ts:77

`Abstract`info

info(message: string, data?: any): void
Parameters
- message: string
- Optionaldata: any
Returns void
- Defined in packages/types/lib/Logger.ts:41

logGrouped

logGrouped(key: string, emit: (count: number) => void): void
Log a message that might be repeated, preventing console spam. If the same key is passed multiple times, only the first time the emit callback will be invoked immediately. All subsequent calls will be buffered, until at least Logger#groupedLogLimit other logGrouped calls are made, or Logger#flush is called.
Parameters
- key: string
  A unique key for this message (e.g. the message template).
- emit: (count: number) => void
  A callback to emit the message.
Returns void
- Defined in packages/types/lib/Logger.ts:56

`Abstract`trace

trace(message: string, data?: any): void
Parameters
- message: string
- Optionaldata: any
Returns void
- Defined in packages/types/lib/Logger.ts:39

`Abstract`warn

warn(message: string, data?: any): void
Parameters
- message: string
- Optionaldata: any
Returns void
- Defined in packages/types/lib/Logger.ts:42

`Static`getLevelOrdinal

getLevelOrdinal(level: string): number
Convert a string-based logging level to a numerical logging level.
Parameters
- level: string
  A string-based logging level
Returns number
The numerical logging level, or undefined.
- Defined in packages/types/lib/Logger.ts:25