Class BasaltLogger

BasaltLogger provides a flexible logging system that allows multiple strategies for log output.

Index

Constructors

Methods

addStrategy clearStrategies debug error info log removeStrategy warn

Constructors

constructor

new BasaltLogger(): BasaltLogger
Initializes the BasaltLogger, creates the log stream (Transform). The log stream processes the log entries and executes the logging strategies.

Returns BasaltLogger
- Defined in source/core/basaltLogger.ts:51

Methods

addStrategy

addStrategy(name: string, strategy: LoggerStrategy): void
Adds a logging strategy.
Parameters
- name: string
  The name of the strategy.
- strategy: LoggerStrategy
  The strategy to add. (LoggerStrategy)
Returns void
Throws
(BasaltError) - If the strategy is already added. (GLOBAL_KEY_ERROR.STRATEGY_ALREADY_ADDED)
- Defined in source/core/basaltLogger.ts:69

clearStrategies

clearStrategies(): void
Clears all logging strategies.

Returns void
- Defined in source/core/basaltLogger.ts:101

debug

debug(object: unknown, strategiesNames?: string[]): void
Logs a debug message.
Parameters
- object: unknown
  The object to log.
- OptionalstrategiesNames: string[]
  The names of the strategies to use. (default: all strategies)
Returns void
- Defined in source/core/basaltLogger.ts:147

error

error(object: unknown, strategiesNames?: string[]): void
Logs an error message.
Parameters
- object: unknown
  The object to log.
- OptionalstrategiesNames: string[]
  The names of the strategies to use. (default: all strategies)
Returns void
Throws
(BasaltError) - If no strategy is added. (GLOBAL_KEY_ERROR.NO_STRATEGY_ADDED)
- Defined in source/core/basaltLogger.ts:113

info

info(object: unknown, strategiesNames?: string[]): void
Logs an info message.
Parameters
- object: unknown
  The object to log.
- OptionalstrategiesNames: string[]
  The names of the strategies to use. (default: all strategies)
Returns void
Throws
(BasaltError) - If no strategy is added. (GLOBAL_KEY_ERROR.NO_STRATEGY_ADDED)
- Defined in source/core/basaltLogger.ts:137

log

log(object: unknown, strategiesNames?: string[]): void
Logs a log message.
Parameters
- object: unknown
  The object to log.
- OptionalstrategiesNames: string[]
  The names of the strategies to use. (default: all strategies)
Returns void
- Defined in source/core/basaltLogger.ts:157

removeStrategy

removeStrategy(name: string): void
Removes a logging strategy by name.
Parameters
- name: string
  The name of the strategy.
Returns void
Throws
(BasaltError) - If the strategy is not found. (GLOBAL_KEY_ERROR.STRATEGY_NOT_FOUND)
- Defined in source/core/basaltLogger.ts:87

warn

warn(object: unknown, strategiesNames?: string[]): void
Logs a warn message.
Parameters
- object: unknown
  The object to log.
- OptionalstrategiesNames: string[]
  The names of the strategies to use. (default: all strategies)
Returns void
Throws
(BasaltError) - If no strategy is added. (GLOBAL_KEY_ERROR.NO_STRATEGY_ADDED)
- Defined in source/core/basaltLogger.ts:125