Class MapLogger<LogMapType>

MapLogger is a logger that extends normal logger and uses a object key mapping to determine the log level for each unique key. It allows for dynamic log level configuration for different log keys.

Example

const defaultLogMap = {
  test: LogLevel.Info,
  input: LogLevel.Debug,
} as const;
export type LogMappingType = LogMapInfer<typeof defaultLogMap>; // build type from default

const logger = new MapLogger<LogMappingType>(console, defaultLogMap);
logger.logKey('test', 'goes to info');
logger.logKey('input', 'goes to debug');

Since

v0.1.0

See

MapLogger

Type Parameters

LogMapType extends Record<string, LogLevelValue>
Object type with LogLevelValue values

Hierarchy

BaseLogger
- MapLogger

Implements

Index

Constructors

constructor

Properties

_logger

Constructors

constructor

new MapLogger<LogMapType extends Record<string, LogLevelValue>>(
logger: undefined | ILoggerLike,
defaultMap: LogMapType,
): MapLogger<LogMapType>
MapLogger constructor with optional logger instance and default log key mapping.
Type Parameters
- LogMapType extends Record<string, LogLevelValue>
Parameters
- logger: undefined | ILoggerLike
  optional logger instance
- defaultMap: LogMapType
  default log key mapping
Returns MapLogger<LogMapType>
See
MapLogger
Overrides BaseLogger.constructor
- Defined in src/MapLogger.mts:74

Properties

`Protected`_logger

_logger: undefined | ILoggerLike

Methods

allLogMapReset

allLogMapReset(): void
Reset temporary log key mapping to original.

Returns void
Implementation of IResetAllLogMapping.allLogMapReset
- Defined in src/MapLogger.mts:109

allLogMapSet

allLogMapSet(level: LogLevelValue): void
Set temporary log key mapping to all keys.
Parameters
- level: LogLevelValue
  log level
Returns void
Implementation of ISetAllLogMapping.allLogMapSet
- Defined in src/MapLogger.mts:100

debug

debug(message: any, ...args: any[]): void
debug level logging
Parameters
- message: any
  message to log
- ...args: any[]
  additional arguments
Returns void
Implementation of ILoggerLike.debug
Inherited from BaseLogger.debug
- Defined in src/BaseLogger.mts:33

error

error(message: any, ...args: any[]): void
error level logging
Parameters
- message: any
  message to log
- ...args: any[]
  additional arguments
Returns void
Implementation of ILoggerLike.error
Inherited from BaseLogger.error
- Defined in src/BaseLogger.mts:60

getLogMapping

getLogMapping(): LogMapType
Get current log key mapping

Returns LogMapType
current log key mapping
Implementation of IGetLogMapping.getLogMapping
- Defined in src/MapLogger.mts:92

`Protected`handleDebug

handleDebug(message: any, ...args: any[]): void
Parameters
- message: any
- ...args: any[]
Returns void
Inherited from BaseLogger.handleDebug
- Defined in src/BaseLogger.mts:80

`Protected`HandleError

HandleError(message: any, ...args: any[]): void
Parameters
- message: any
- ...args: any[]
Returns void
Inherited from BaseLogger.HandleError
- Defined in src/BaseLogger.mts:104

`Protected`handleInfo

handleInfo(message: any, ...args: any[]): void
Parameters
- message: any
- ...args: any[]
Returns void
Inherited from BaseLogger.handleInfo
- Defined in src/BaseLogger.mts:88

`Protected`handleLogCall

handleLogCall(level: LogLevelValue, message: any, ...args: any[]): void
this handles logic rules for logging
Parameters
- level: LogLevelValue
- message: any
- ...args: any[]
Returns void
Overrides BaseLogger.handleLogCall
- Defined in src/MapLogger.mts:156

`Protected`handleTrace

handleTrace(message: any, ...args: any[]): void
Parameters
- message: any
- ...args: any[]
Returns void
Inherited from BaseLogger.handleTrace
- Defined in src/BaseLogger.mts:72

`Protected`handleWarn

handleWarn(message: any, ...args: any[]): void
Parameters
- message: any
- ...args: any[]
Returns void
Inherited from BaseLogger.handleWarn
- Defined in src/BaseLogger.mts:96

hasLoggerInstance

hasLoggerInstance(): boolean
Check if logger instance exists

Returns boolean
true if logger instance exists
Implementation of IHasLoggerInstance.hasLoggerInstance
Inherited from BaseLogger.hasLoggerInstance
- Defined in src/BaseLogger.mts:68

info

info(message: any, ...args: any[]): void
info level logging
Parameters
- message: any
  message to log
- ...args: any[]
  additional arguments
Returns void
Implementation of ILoggerLike.info
Inherited from BaseLogger.info
- Defined in src/BaseLogger.mts:42

logKey

logKey(key: keyof LogMapType, message: any, ...args: any[]): void
Log message with level based on log key mapping
Parameters
- key: keyof LogMapType
  log key
- message: any
  message to log
- ...args: any[]
  additional arguments
Returns void
Throws
if log key is not found
Implementation of IMappingLogKey.logKey
- Defined in src/MapLogger.mts:120

setLogger

setLogger(logger: undefined | ILoggerLike): void
Set or unset logger instance
Parameters
- logger: undefined | ILoggerLike
  logger instance or undefined
Returns void
Implementation of ISetOptionalLogger.setLogger
Inherited from BaseLogger.setLogger
- Defined in src/BaseLogger.mts:15

setLogMapping

setLogMapping(map: Partial<LogMapInfer<LogMapType>>): void
Set new log key mapping
Parameters
- map: Partial<LogMapInfer<LogMapType>>
  new log key mapping
Returns void
Implementation of ISetLogMapping.setLogMapping
- Defined in src/MapLogger.mts:84

toJSON

toJSON(): MapLoggerToJson<LogMapType>
Get JSON representation of the logger.

Returns MapLoggerToJson<LogMapType>
An object with the class name, logger status, and the log mapping object.
Example
```
const logger = new MapLogger<LogMappingType>(console, defaultLogMap);
console.log(logger.toJSON());
// output: {"$class":"MapLogger","map":{"foo":2,"bar":3},"logger":true}
```
- Defined in src/MapLogger.mts:148

toString

toString(): `MapLogger(${string})`
Get string representation of the logger.

Returns `MapLogger(${string})`
String representation of the logger, e.g. MapLogger(logger: true, map: { foo: 2, bar: 3 })
- Defined in src/MapLogger.mts:136

trace

trace(message: any, ...args: any[]): void
trace level logging
Parameters
- message: any
  message to log
- ...args: any[]
  additional arguments
Returns void
Implementation of ILoggerLike.trace
Inherited from BaseLogger.trace
- Defined in src/BaseLogger.mts:24

warn

warn(message: any, ...args: any[]): void
warn level logging
Parameters
- message: any
  message to log
- ...args: any[]
  additional arguments
Returns void
Implementation of ILoggerLike.warn
Inherited from BaseLogger.warn
- Defined in src/BaseLogger.mts:51

Class MapLogger<LogMapType>

Example

Since

See

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns MapLogger<LogMapType>

See

Properties

Protected_logger

Methods

allLogMapReset

Returns void

allLogMapSet

Parameters

Returns void

debug

Parameters

Returns void

error

Parameters

Returns void

getLogMapping

Returns LogMapType

ProtectedhandleDebug

Parameters

Returns void

ProtectedHandleError

Parameters

Returns void

ProtectedhandleInfo

Parameters

Returns void

ProtectedhandleLogCall

Parameters

Returns void

ProtectedhandleTrace

Parameters

Returns void

ProtectedhandleWarn

Parameters

Returns void

hasLoggerInstance

Returns boolean

info

Parameters

Returns void

logKey

Parameters

Returns void

Throws

setLogger

Parameters

Returns void

setLogMapping

Parameters

Returns void

toJSON

Returns MapLoggerToJson<LogMapType>

Example

toString

Returns `MapLogger(${string})`

trace

Parameters

Returns void

warn

Parameters

Returns void

Settings

On This Page

`Protected`_logger

`Protected`handleDebug

`Protected`HandleError

`Protected`handleInfo

`Protected`handleLogCall

`Protected`handleTrace

`Protected`handleWarn