Interface LoggerInterface

Interface for a logger instance. Defines the public API that all logger implementations must follow.

interface LoggerInterface {
    child(context: { component: string }): LoggerInterface;
    debug(message: string, ...args: unknown[]): void;
    error(message: string, ...args: unknown[]): void;
    getContext(): LogContext | undefined;
    info(message: string, ...args: unknown[]): void;
    runWithContext<T>(context: LogContext, fn: () => T): T;
    trace(message: string, ...args: unknown[]): void;
    warn(message: string, ...args: unknown[]): void;
}

Implemented by

Logger

Index

Methods

child debug error getContext info runWithContext trace warn

Methods

child

child(context: { component: string }): LoggerInterface
Create a child logger with a specific component context.
Parameters
- context: { component: string }
  The component context for the child logger
Returns LoggerInterface
A new logger instance with the specified context
- Defined in src/logger/core/types.ts:141

debug

debug(message: string, ...args: unknown[]): void
Log a message at DEBUG level.
Parameters
- message: string
  The message to log (supports printf-style formatting)
- ...args: unknown[]
  Additional arguments for formatting or metadata
Returns void
- Defined in src/logger/core/types.ts:113

error

error(message: string, ...args: unknown[]): void
Log a message at ERROR level.
Parameters
- message: string
  The message to log (supports printf-style formatting)
- ...args: unknown[]
  Additional arguments for formatting or metadata
Returns void
- Defined in src/logger/core/types.ts:134

getContext

getContext(): LogContext | undefined
Get the current logging context.

Returns LogContext | undefined
The current context or undefined if not in a context
- Defined in src/logger/core/types.ts:155

info

info(message: string, ...args: unknown[]): void
Log a message at INFO level.
Parameters
- message: string
  The message to log (supports printf-style formatting)
- ...args: unknown[]
  Additional arguments for formatting or metadata
Returns void
- Defined in src/logger/core/types.ts:120

runWithContext

runWithContext<T>(context: LogContext, fn: () => T): T
Run a function within a logging context.
Type Parameters
- T
Parameters
- context: LogContext
  The context to use for logging
- fn: () => T
  The function to execute
Returns T
The result of the function
- Defined in src/logger/core/types.ts:149

trace

trace(message: string, ...args: unknown[]): void
Log a message at TRACE level.
Parameters
- message: string
  The message to log (supports printf-style formatting)
- ...args: unknown[]
  Additional arguments for formatting or metadata
Returns void
- Defined in src/logger/core/types.ts:106

warn

warn(message: string, ...args: unknown[]): void
Log a message at WARN level.
Parameters
- message: string
  The message to log (supports printf-style formatting)
- ...args: unknown[]
  Additional arguments for formatting or metadata
Returns void
- Defined in src/logger/core/types.ts:127

Interface LoggerInterface

Implemented by

Index

Methods

Methods

child

Parameters

Returns LoggerInterface

debug

Parameters

Returns void

error

Parameters

Returns void

getContext

Returns LogContext | undefined

info

Parameters

Returns void

runWithContext

Type Parameters

Parameters

Returns T

trace

Parameters

Returns void

warn

Parameters

Returns void

Settings

On This Page