Class Logger

Hierarchy

Logger

Implements

ILogger

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Logger(context?: string): Logger

- Defined in logger.ts:64
Creates a new logger with no handlers configured. Add handlers with addHandler using a Fluent API.

Parameters
- Optional context: string
  
  Context for the new logger. Defaults to Default.
Returns Logger

Properties

Private Readonly _context

_context: string

Private _metadata

_metadata: Record<string, unknown> = ...

Private handlers

handlers: ILogHandler[] = ...

Accessors

context

get context(): string

Implementation of ILogger.context
- Defined in logger.ts:75
Current context this logger is scoped to.

Returns string

metadata

get metadata(): Record<string, unknown>

Implementation of ILogger.metadata
- Defined in logger.ts:79
Current metadata stored on this logger.

Returns Record<string, unknown>

Methods

addHandler

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

- Defined in logger.ts:103
Parameters
- handler: ILogHandler
- Optional condition: boolean | (() => boolean)
Returns ILogger

Private addHandlers

addHandlers(handlers: ILogHandler[]): ILogger

- Defined in logger.ts:95
Parameters
- handlers: ILogHandler[]
Returns ILogger

addMetadata

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

Implementation of ILogger.addMetadata
- Defined in logger.ts:89
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>
Returns ILogger

critical

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

Implementation of ILogger.critical
- Defined in logger.ts:145
Sends a log record with the level CRITICAL to all handlers.

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

debug

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

Implementation of ILogger.debug
- Defined in logger.ts:129
Sends a log record with the level DEBUG to all handlers.

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

error

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

Implementation of ILogger.error
- Defined in logger.ts:141
Sends a log record with the level ERROR to all handlers.

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

info

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

Implementation of ILogger.info
- Defined in logger.ts:133
Sends a log record with the level INFO to all handlers.

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

Private notifyHandlers

notifyHandlers(level: LogLevel, args: unknown[]): void

- Defined in logger.ts:114
Parameters
- level: LogLevel
- args: unknown[]
Returns void

verbose

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

Implementation of ILogger.verbose
- Defined in logger.ts:125
Sends a log record with the level VERBOSE to all handlers.

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

warning

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

Implementation of ILogger.warning
- Defined in logger.ts:137
Sends a log record with the level WARNING to all handlers.

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

withContext

withContext(context: string): ILogger

Implementation of ILogger.withContext
- Defined in logger.ts:83
Creates a new logger scoped to a given context. All current handlers and metadata is copied over to the logger.

Parameters
- context: string
Returns ILogger

Generated using TypeDoc