Class Logger<Config>

A thin wrapper on top of Pino with support for disabling the logger.

The config is same as the options accepted by pino with following additions

enabled: A flag to turn off the logger. You can still use the logger API, but nothing will be logged.
destination: A stream to pass to pino as the desintation stream. With pino, you pass is at the 2nd argument, with Logger, you pass it as an option.

const logger = new Logger({ enabled: true })
logger.info('hello world')

const logger = new Logger({ enabled: true, desintation: pino.destination(2) })
logger.error('something went wrong')

Type Parameters

Config extends LoggerConfig = LoggerConfig

Hierarchy (View Summary)

Logger
- LoggerManager

Index

Constructors

constructor

new Logger<Config extends LoggerConfig = LoggerConfig>(
config: Config,
pino?: Logger<string>,
): Logger<Config>
Creates a new Logger instance
Type Parameters
- Config extends LoggerConfig = LoggerConfig
Parameters
- config: Config
  Logger configuration
- Optionalpino: Logger<string>
  Optional Pino logger instance
Returns Logger<Config>
- Defined in src/logger.ts:48

Properties

pino

pino: Logger<string>

The underlying Pino logger instance

Accessors

isEnabled

get isEnabled(): boolean
Check if the logger is enabled

Returns boolean
True if the logger is enabled
- Defined in src/logger.ts:63

levels

get levels(): LevelMapping
A map of levels

Returns LevelMapping
The level mapping object
- Defined in src/logger.ts:71

level

get level(): string
Returns the current logger level

Returns string
The current log level as a string
- Defined in src/logger.ts:83
set level(level: string): void
Update logger level
Parameters
- level: string
  The new log level to set
Returns void
- Defined in src/logger.ts:95

levelNumber

get levelNumber(): number
Returns the current logger level number

Returns number
The current log level as a number
- Defined in src/logger.ts:108

pinoVersion

get pinoVersion(): string
Returns the pino version

Returns string
The Pino version string
- Defined in src/logger.ts:120

version

get version(): string
Returns the pino version

Returns string
The Pino version string
- Defined in src/logger.ts:128

Methods

isLevelEnabled

isLevelEnabled(level: string): boolean
Returns a boolean telling if level is enabled or not
Parameters
- level: string
  The log level to check
Returns boolean
True if the specified level is enabled
- Defined in src/logger.ts:137

ifLevelEnabled

ifLevelEnabled(
level: string,
callback: (logger: this) => Promise<void>,
): Promise<void>
Run the callback when the level is enabled. Helpful for conditionally logging, especially when the processing of computing log data is expensive.
```
logger.ifLevelEnabled('trace', () => {
  const data = inspect(someValue)
  logger.info(data)
})
```
Parameters
- level: string
  The log level to check
- callback: (logger: this) => Promise<void>
  The callback function to execute if level is enabled
Returns Promise<void>
- Defined in src/logger.ts:159
ifLevelEnabled(level: string, callback: (logger: this) => void): void
Run the callback when the level is enabled. Helpful for conditionally logging, especially when the processing of computing log data is expensive.
```
logger.ifLevelEnabled('trace', () => {
  const data = inspect(someValue)
  logger.info(data)
})
```
Parameters
- level: string
  The log level to check
- callback: (logger: this) => void
  The callback function to execute if level is enabled
Returns void
- Defined in src/logger.ts:160

log

log(
    level: LevelWithSilent | keyof Config["customLevels"],
    message: string,
    ...values: any[],
): void
Log message for any named level
Parameters
- level: LevelWithSilent | keyof Config["customLevels"]
  The log level to use
- message: string
  The log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:173
log(
    level: LevelWithSilent | keyof Config["customLevels"],
    mergingObject: any,
    message: string,
    ...values: any[],
): void
Log message for any named level with merging object
Parameters
- level: LevelWithSilent | keyof Config["customLevels"]
  The log level to use
- mergingObject: any
  Object to merge with log entry
- message: string
  The log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:185

trace

trace<T extends object>(obj: T, message?: string, ...values: any[]): void
Log message at trace level
Type Parameters
- T extends object
Parameters
- obj: T
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:213
trace(obj: unknown, message?: string, ...values: any[]): void
Log message at trace level
Parameters
- obj: unknown
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:220
trace(message: string, ...values: any[]): void
Log message at trace level
Parameters
- message: string
  The log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:226

debug

debug<T extends object>(obj: T, message?: string, ...values: any[]): void
Log message at debug level
Type Parameters
- T extends object
Parameters
- obj: T
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:237
debug(obj: unknown, message?: string, ...values: any[]): void
Log message at debug level
Parameters
- obj: unknown
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:244
debug(message: string, ...values: any[]): void
Log message at debug level
Parameters
- message: string
  The log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:250

info

info<T extends object>(obj: T, message?: string, ...values: any[]): void
Log message at info level
Type Parameters
- T extends object
Parameters
- obj: T
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:261
info(obj: unknown, message?: string, ...values: any[]): void
Log message at info level
Parameters
- obj: unknown
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:268
info(message: string, ...values: any[]): void
Log message at info level
Parameters
- message: string
  The log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:274

warn

warn<T extends object>(obj: T, message?: string, ...values: any[]): void
Log message at warn level
Type Parameters
- T extends object
Parameters
- obj: T
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:285
warn(obj: unknown, message?: string, ...values: any[]): void
Log message at warn level
Parameters
- obj: unknown
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:292
warn(message: string, ...values: any[]): void
Log message at warn level
Parameters
- message: string
  The log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:298

error

error<T extends object>(obj: T, message?: string, ...values: any[]): void
Log message at error level
Type Parameters
- T extends object
Parameters
- obj: T
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:309
error(obj: unknown, message?: string, ...values: any[]): void
Log message at error level
Parameters
- obj: unknown
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:316
error(message: string, ...values: any[]): void
Log message at error level
Parameters
- message: string
  The log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:322

fatal

fatal<T extends object>(obj: T, message?: string, ...values: any[]): void
Log message at fatal level
Type Parameters
- T extends object
Parameters
- obj: T
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:333
fatal(obj: unknown, message?: string, ...values: any[]): void
Log message at fatal level
Parameters
- obj: unknown
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:340
fatal(message: string, ...values: any[]): void
Log message at fatal level
Parameters
- message: string
  The log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:346

silent

silent<T extends object>(obj: T, message?: string, ...values: any[]): void
Log message at silent level
Type Parameters
- T extends object
Parameters
- obj: T
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:357
silent(obj: unknown, message?: string, ...values: any[]): void
Log message at silent level
Parameters
- obj: unknown
  Object to log or merge
- Optionalmessage: string
  Optional log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:364
silent(message: string, ...values: any[]): void
Log message at silent level
Parameters
- message: string
  The log message
- ...values: any[]
  Additional values to log
Returns void
- Defined in src/logger.ts:370

child

child<ChildOptions extends ChildLoggerOptions<never>>(
bindings: Bindings,
options?: ChildOptions,
): Logger<Config>
Returns a child logger instance
Type Parameters
- ChildOptions extends ChildLoggerOptions<never>
Parameters
- bindings: Bindings
  Bindings to add to the child logger
- Optionaloptions: ChildOptions
  Optional child logger options
Returns Logger<Config>
A new child logger instance
- Defined in src/logger.ts:381

bindings

bindings(): Bindings
Returns default bindings for the logger

Returns Bindings
The default bindings object
- Defined in src/logger.ts:396

Class Logger<Config>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Logger<Config>

Properties

pino

Accessors

isEnabled

Returns boolean

levels

Returns LevelMapping

level

Returns string

Parameters

Returns void

levelNumber

Returns number

pinoVersion

Returns string

version

Returns string

Methods

isLevelEnabled

Parameters

Returns boolean

ifLevelEnabled

Parameters

Returns Promise<void>

Parameters

Returns void

log

Parameters

Returns void

Parameters

Returns void

trace

Type Parameters

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

debug

Type Parameters

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

info

Type Parameters

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

warn

Type Parameters

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

error

Type Parameters

Parameters

Returns void