Skip to main content

Interface: LoggerInterface

Defined in: src/services/logger.ts:41

Interface for the logger configuration.

Remarksโ€‹

Extends the unified logger interface with specialized logging methods for frontend-specific functionality while maintaining compatibility with the backend logger interface.

Extendsโ€‹

Propertiesโ€‹

debug()โ€‹

debug: (message: string, ...args: unknown[]) => void

Defined in: shared/utils/logger/interfaces.ts:31

Log debug information for development and troubleshooting.

Parametersโ€‹

messageโ€‹

string

The debug message to log

argsโ€‹

...unknown[]

Additional arguments for context

Returnsโ€‹

void

Inherited fromโ€‹

UnifiedLogger.debug


error()โ€‹

error: (message: string, error?: unknown, ...args: unknown[]) => void

Defined in: shared/utils/logger/interfaces.ts:44

Log error messages with optional error objects.

Parametersโ€‹

messageโ€‹

string

The error message to log

error?โ€‹

unknown

Optional error object or additional context

args?โ€‹

...unknown[]

Additional arguments for context

Returnsโ€‹

void

Remarksโ€‹

When an https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error object is provided, the logger should extract and format the error message and stack trace appropriately for debugging.

Inherited fromโ€‹

UnifiedLogger.error


info()โ€‹

info: (message: string, ...args: unknown[]) => void

Defined in: shared/utils/logger/interfaces.ts:52

Log general informational messages.

Parametersโ€‹

messageโ€‹

string

The information message to log

argsโ€‹

...unknown[]

Additional arguments for context

Returnsโ€‹

void

Inherited fromโ€‹

UnifiedLogger.info


warn()โ€‹

warn: (message: string, ...args: unknown[]) => void

Defined in: shared/utils/logger/interfaces.ts:60

Log warning messages for potential issues.

Parametersโ€‹

messageโ€‹

string

The warning message to log

argsโ€‹

...unknown[]

Additional arguments for context

Returnsโ€‹

void

Inherited fromโ€‹

UnifiedLogger.warn


silly()โ€‹

silly: (message: string, ...args: unknown[]) => void

Defined in: shared/utils/logger/interfaces.ts:79

Log verbose debugging information with extreme detail.

Parametersโ€‹

messageโ€‹

string

The silly level message to log

argsโ€‹

...unknown[]

Additional arguments for context

Returnsโ€‹

void

Inherited fromโ€‹

UnifiedLogger.silly


verbose()โ€‹

verbose: (message: string, ...args: unknown[]) => void

Defined in: shared/utils/logger/interfaces.ts:87

Log detailed debugging information.

Parametersโ€‹

messageโ€‹

string

The verbose level message to log

argsโ€‹

...unknown[]

Additional arguments for context

Returnsโ€‹

void

Inherited fromโ€‹

UnifiedLogger.verbose


appโ€‹

app: AppLogger

Defined in: src/services/logger.ts:44

Specialized logging methods for common scenarios Log application lifecycle events

Overridesโ€‹

UnifiedLogger.app


rawโ€‹

raw: RendererLogger & { default: RendererLogger; }

Defined in: src/services/logger.ts:60

Raw access to the underlying electron-log instance.

Type Declarationโ€‹

defaultโ€‹

default: RendererLogger

Remarksโ€‹

Use with caution! Direct access bypasses the application's logging conventions and structured format. Only use for advanced scenarios where the standard logger methods are insufficient.

Exampleโ€‹

// Only use when absolutely necessary
logger.raw.transports.file.level = "warn";

siteโ€‹

site: SiteLogger

Defined in: src/services/logger.ts:64

Log site monitoring events

Overridesโ€‹

UnifiedLogger.site


systemโ€‹

system: SystemLogger

Defined in: src/services/logger.ts:66

Log system/electron events

Overridesโ€‹

UnifiedLogger.system


userโ€‹

user: UserLogger

Defined in: src/services/logger.ts:68

Log user actions

Overridesโ€‹

UnifiedLogger.user