@maroonedsoftware/logger

A simple, dependency injection friendly logging abstraction with multiple log levels.

Installation

pnpm add @maroonedsoftware/logger

Usage

Basic Usage

import { ConsoleLogger } from '@maroonedsoftware/logger';

const logger = new ConsoleLogger();

logger.error('Something went wrong', { details: 'error context' });
logger.warn('This might be a problem');
logger.info('Application started');
logger.debug('Processing request', requestData);
logger.trace('Entering function');

With Dependency Injection

The Logger abstract class is decorated with @Injectable() from injectkit, making it easy to use with DI containers:

import 'reflect-metadata';
import { InjectKitRegistry } from 'injectkit';
import { Logger, ConsoleLogger } from '@maroonedsoftware/logger';

// Set up dependency injection registry
const diRegistry = new InjectKitRegistry();
diRegistry.register(Logger).useClass(ConsoleLogger).asSingleton();

// Build the container
const container = diRegistry.build();

// Resolve the logger
const logger = container.get(Logger);
logger.info('Application started');

In your services, use constructor injection:

import { Injectable } from 'injectkit';
import { Logger } from '@maroonedsoftware/logger';

@Injectable()
class MyService {
  constructor(private logger: Logger) {}

  doSomething() {
    this.logger.info('Doing something');
  }
}

API

Logger Interface

| Method | Description | | --------------------------- | ----------------------------- | | error(message, ...params) | Logs an error message | | warn(message, ...params) | Logs a warning message | | info(message, ...params) | Logs an informational message | | debug(message, ...params) | Logs a debug message | | trace(message, ...params) | Logs a trace message |

ConsoleLogger

A concrete implementation that outputs to the standard console. Accepts an optional Console instance in the constructor for custom console implementations.

// Use global console (default)
const logger = new ConsoleLogger();

// Use custom console
const customConsole = { ... };
const logger = new ConsoleLogger(customConsole);

License

MIT