Skip to main content

Interface: LoggerInterface

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

Interface for the logger configuration.

Propertiesโ€‹

appโ€‹

app: { error: (context: string, error: Error) => void; performance: (operation: string, duration: number) => void; started: () => void; stopped: () => void; }

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

Log application lifecycle events

error()โ€‹

error: (context: string, error: Error) => void

Parametersโ€‹
contextโ€‹

string

errorโ€‹

Error

Returnsโ€‹

void

performance()โ€‹

performance: (operation: string, duration: number) => void

Parametersโ€‹
operationโ€‹

string

durationโ€‹

number

Returnsโ€‹

void

started()โ€‹

started: () => void

Returnsโ€‹

void

stopped()โ€‹

stopped: () => void

Returnsโ€‹

void


debug()โ€‹

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

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

Debug level - for development debugging

Parametersโ€‹

messageโ€‹

string

argsโ€‹

...unknown[]

Returnsโ€‹

void


error()โ€‹

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

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

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global\_Objects/Error level - errors that should be investigated

Parametersโ€‹

messageโ€‹

string

error?โ€‹

Error

args?โ€‹

...unknown[]

Returnsโ€‹

void


info()โ€‹

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

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

Info level - general application flow

Parametersโ€‹

messageโ€‹

string

argsโ€‹

...unknown[]

Returnsโ€‹

void


rawโ€‹

raw: RendererLogger & { default: RendererLogger; }

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

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";

silly()โ€‹

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

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

Silly level - extremely detailed debugging

Parametersโ€‹

messageโ€‹

string

argsโ€‹

...unknown[]

Returnsโ€‹

void


siteโ€‹

site: { added: (identifier: string) => void; check: (identifier: string, status: string, responseTime?: number) => void; error: (identifier: string, error: string | Error) => void; removed: (identifier: string) => void; statusChange: (identifier: string, oldStatus: string, newStatus: string) => void; }

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

Specialized logging methods for common scenarios Log site monitoring events

added()โ€‹

added: (identifier: string) => void

Parametersโ€‹
identifierโ€‹

string

Returnsโ€‹

void

check()โ€‹

check: (identifier: string, status: string, responseTime?: number) => void

Parametersโ€‹
identifierโ€‹

string

statusโ€‹

string

responseTime?โ€‹

number

Returnsโ€‹

void

error()โ€‹

error: (identifier: string, error: string | Error) => void

Parametersโ€‹
identifierโ€‹

string

errorโ€‹

string | Error

Returnsโ€‹

void

removed()โ€‹

removed: (identifier: string) => void

Parametersโ€‹
identifierโ€‹

string

Returnsโ€‹

void

statusChange()โ€‹

statusChange: (identifier: string, oldStatus: string, newStatus: string) => void

Parametersโ€‹
identifierโ€‹

string

oldStatusโ€‹

string

newStatusโ€‹

string

Returnsโ€‹

void


systemโ€‹

system: { notification: (title: string, body: string) => void; tray: (action: string) => void; window: (action: string, windowName?: string) => void; }

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

Log system/electron events

notification()โ€‹

notification: (title: string, body: string) => void

Parametersโ€‹
titleโ€‹

string

bodyโ€‹

string

Returnsโ€‹

void

tray()โ€‹

tray: (action: string) => void

Parametersโ€‹
actionโ€‹

string

Returnsโ€‹

void

window()โ€‹

window: (action: string, windowName?: string) => void

Parametersโ€‹
actionโ€‹

string

windowName?โ€‹

string

Returnsโ€‹

void


userโ€‹

user: { action: (action: string, details?: unknown) => void; settingsChange: (setting: string, oldValue: unknown, newValue: unknown) => void; }

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

Log user actions

action()โ€‹

action: (action: string, details?: unknown) => void

Parametersโ€‹
actionโ€‹

string

details?โ€‹

unknown

Returnsโ€‹

void

settingsChange()โ€‹

settingsChange: (setting: string, oldValue: unknown, newValue: unknown) => void

Parametersโ€‹
settingโ€‹

string

oldValueโ€‹

unknown

newValueโ€‹

unknown

Returnsโ€‹

void


verbose()โ€‹

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

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

Verbose level - very detailed debugging

Parametersโ€‹

messageโ€‹

string

argsโ€‹

...unknown[]

Returnsโ€‹

void


warn()โ€‹

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

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

Warn level - something unexpected but not an error

Parametersโ€‹

messageโ€‹

string

argsโ€‹

...unknown[]

Returnsโ€‹

void