Interfaces

TypeScript interfaces and types used by @shinijs/logger.

ILogger

Main logger interface implemented by CustomLogger and ContextBoundLogger.

interface ILogger {
  log(message: string, context?: string): void;
  error(message: string, error?: Error | unknown, context?: LogContext): void;
  warn(message: string, meta?: Record<string, unknown>, context?: LogContext): void;
  info(message: string, meta?: Record<string, unknown>, context?: LogContext): void;
  debug(message: string, meta?: Record<string, unknown>, context?: LogContext): void;
  verbose(message: string, meta?: Record<string, unknown>, context?: LogContext): void;
  fatal(message: string, meta?: Record<string, unknown>, context?: LogContext): void;
  setContext(context: string): void;
  getContext(): string;
}

Usage

import type { ILogger } from '@shinijs/logger';

function processWithLogger(logger: ILogger) {
  logger.info('Processing...');
}

LogLevel

Type representing log levels.

type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal';

Values

• 'trace' - Very detailed debugging information
• 'debug' - Debug messages
• 'info' - Informational messages
• 'warn' - Warning messages
• 'error' - Error messages
• 'fatal' - Fatal errors

LogContext

Type representing log context. Can be a string or a rich context object.

type LogContext = string | LogContextObject;

String Context

this.logger.info('Message', {}, 'MyService');

Object Context

this.logger.info('Message', {}, {
  requestId: 'req-123',
  userId: 'user-456',
  method: 'POST',
  url: '/api/users',
});

LogContextObject

Interface for rich context objects.

interface LogContextObject {
  requestId?: string;
  userId?: string;
  userEmail?: string;
  ip?: string;
  userAgent?: string;
  method?: string;
  url?: string;
  statusCode?: number;
  responseTime?: number;
  [key: string]: unknown;
}

Properties

• requestId - Request identifier
• userId - User identifier
• userEmail - User email
• ip - Client IP address
• userAgent - User agent string
• method - HTTP method
• url - Request URL
• statusCode - HTTP status code
• responseTime - Response time in milliseconds
• [key: string]: unknown - Additional custom properties

Example

this.logger.info('Request processed', {}, {
  requestId: 'req-123',
  userId: 'user-456',
  method: 'POST',
  url: '/api/users',
  statusCode: 201,
  responseTime: 45,
  customField: 'value',
});

LogMetadata

Interface for log metadata.

interface LogMetadata {
  context?: string;
  timestamp?: string;
  level?: LogLevel;
  stack?: string;
  [key: string]: unknown;
}

Properties

• context - Log context
• timestamp - Timestamp string
• level - Log level
• stack - Error stack trace
• [key: string]: unknown - Additional metadata

Importing Types

import type {
  ILogger,
  LogLevel,
  LogContext,
  LogContextObject,
  LogMetadata,
} from '@shinijs/logger';

Type Guards

Checking Log Level

function isValidLogLevel(level: string): level is LogLevel {
  return ['error', 'warn', 'info', 'debug'].includes(level);
}

Checking Context Type

function isContextObject(context: LogContext): context is LogContextObject {
  return typeof context === 'object' && context !== null;
}

See Also

• CustomLogger - Logger implementation
• LoggerFactory - Factory for context-bound loggers
• Configuration - Configuration types