Class KeyLoggerPlugin<LogMapType>

LoggerPlugin is a plugin interface for loggers that allows you to modify log messages before they are logged.

Since

v0.0.6

See

Type Parameters

LogMapType extends Record<string, LogLevelType>

Implements

LoggerPlugin

Index

Constructors

Accessors

Methods

handle key setAllLevel

Constructors

constructor

new KeyLoggerPlugin<LogMapType extends Record<string, LogLevelType>>(
options: KeyLoggerPluginOptions<LogMapType>,
): KeyLoggerPlugin<LogMapType>
Type Parameters
- LogMapType extends Record<string, LogLevelType>
Parameters
- options: KeyLoggerPluginOptions<LogMapType>
Returns KeyLoggerPlugin<LogMapType>
- Defined in KeyLoggerPlugin.ts:29

Accessors

logMap

get logMap(): KeyLoggerMapInfer<LogMapType>
Returns KeyLoggerMapInfer<LogMapType>
- Defined in KeyLoggerPlugin.ts:39
set logMap(value: Partial<KeyLoggerMapInfer<LogMapType>>): void
Parameters
- value: Partial<KeyLoggerMapInfer<LogMapType>>
Returns void
- Defined in KeyLoggerPlugin.ts:43

Methods

handle

handle(level: LogMethod, message: any, ...args: any[]): PluginResult
Parameters
- level: LogMethod
- message: any
- ...args: any[]
Returns PluginResult
Implementation of LoggerPlugin.handle
- Defined in KeyLoggerPlugin.ts:35

key

key(
    key: keyof LogMapType,
    message: any,
    ...args: any[],
): PluginResult | undefined
Parameters
- key: keyof LogMapType
- message: any
- ...args: any[]
Returns PluginResult | undefined
- Defined in KeyLoggerPlugin.ts:60

setAllLevel

setAllLevel(level: LogLevelType | undefined): void
Set temporary log key mapping to all keys or reset to default mapping if level is undefined.
Parameters
- level: LogLevelType | undefined
  log level to set for all keys or undefined to reset to default mapping
Returns void
- Defined in KeyLoggerPlugin.ts:51