Interface ILogger

Hierarchy

ILogger

Implemented by

Logger

Index

Properties

Methods

Properties

Readonly context

context: string

Current context this logger is scoped to.

Readonly metadata

metadata: Record<string, unknown>

Current metadata stored on this logger.

Methods

addHandler

addHandler(handler: ILogHandler, condition?: boolean | (() => boolean)): ILogger

- Defined in logger.ts:38
Attaches an ILogHandler to this instance. All created ILogRecords will be passed to the given handler.

Parameters
- handler: ILogHandler
  
  Handler that receives created ILogRecords
- Optional condition: boolean | (() => boolean)
  
  Optional condition for adding the handler. Allows handlers to be added conditionally while using a fluent api.
Returns ILogger

addMetadata

addMetadata(metadata: Record<string, unknown>): ILogger

- Defined in logger.ts:48
Adds a metadata object to the logger which will be included in created ILogRecords. New metadata will be merged with existing metadata. Existing keys will be overwritten.

Parameters
- metadata: Record<string, unknown>
  
  Metadata to add to the logger
Returns ILogger

critical

critical(...args: unknown[]): void

- Defined in logger.ts:22
Sends a log record with the level CRITICAL to all handlers.

Parameters
- Rest ...args: unknown[]
Returns void

debug

debug(...args: unknown[]): void

- Defined in logger.ts:10
Sends a log record with the level DEBUG to all handlers.

Parameters
- Rest ...args: unknown[]
Returns void

error

error(...args: unknown[]): void

- Defined in logger.ts:19
Sends a log record with the level ERROR to all handlers.

Parameters
- Rest ...args: unknown[]
Returns void

info

info(...args: unknown[]): void

- Defined in logger.ts:13
Sends a log record with the level INFO to all handlers.

Parameters
- Rest ...args: unknown[]
Returns void

verbose

verbose(...args: unknown[]): void

- Defined in logger.ts:7
Sends a log record with the level VERBOSE to all handlers.

Parameters
- Rest ...args: unknown[]
Returns void

warning

warning(...args: unknown[]): void

- Defined in logger.ts:16
Sends a log record with the level WARNING to all handlers.

Parameters
- Rest ...args: unknown[]
Returns void

withContext

withContext(context: string): ILogger

- Defined in logger.ts:29
Creates a new logger scoped to a given context. All current handlers and metadata is copied over to the logger.

Parameters
- context: string
  
  New scope for the logger.
Returns ILogger

Generated using TypeDoc