Skip to main content

Function: createLoggingMiddleware()

createLoggingMiddleware(options: { filter?: (eventName: string) => boolean; includeData?: boolean; level?: "error" | "info" | "warn" | "debug"; }): EventMiddleware

Defined in: electron/events/middleware.ts:492

Logging middleware that logs all events with configurable detail levels.

Parameters​

options​

Configuration options for event logging

filter?​

(eventName: string) => boolean

includeData?​

boolean

level?​

"error" | "info" | "warn" | "debug"

Returns​

EventMiddleware

EventMiddleware function that logs events at the specified level

Remarks​

Options include:

  • filter: Function to determine which events to log
  • includeData: Whether to include event data in logs (default: false)
  • level: Log level to use ('debug', 'info', 'warn', 'error') (default: 'info')

Example​

const loggingMiddleware = createLoggingMiddleware({
    level: "debug",
    includeData: true,
    filter: (eventName) => eventName.startsWith("user:"),
});
eventBus.use(loggingMiddleware);