@@ -3,6 +3,14 @@ import { logError, logInfo, logWarn } from '../../../shared/logger';
33import type { GitifyNotification } from '../../types' ;
44
55// Renderer logger augments log entries with notification context formatting.
6+
7+ /**
8+ * Logs an informational message from the renderer process.
9+ *
10+ * @param type - A short label identifying the caller or module (e.g. `'getAllNotifications'`).
11+ * @param message - The log message.
12+ * @param notification - Optional notification to include as context in the log entry.
13+ */
614export function rendererLogInfo (
715 type : string ,
816 message : string ,
@@ -11,6 +19,13 @@ export function rendererLogInfo(
1119 logInfo ( type , message , buildContexts ( notification ) ) ;
1220}
1321
22+ /**
23+ * Logs a warning message from the renderer process.
24+ *
25+ * @param type - A short label identifying the caller or module.
26+ * @param message - The warning message.
27+ * @param notification - Optional notification to include as context in the log entry.
28+ */
1429export function rendererLogWarn (
1530 type : string ,
1631 message : string ,
@@ -19,6 +34,14 @@ export function rendererLogWarn(
1934 logWarn ( type , message , buildContexts ( notification ) ) ;
2035}
2136
37+ /**
38+ * Logs an error from the renderer process.
39+ *
40+ * @param type - A short label identifying the caller or module.
41+ * @param message - A description of the error context.
42+ * @param err - The error object that was caught.
43+ * @param notification - Optional notification to include as context in the log entry.
44+ */
2245export function rendererLogError (
2346 type : string ,
2447 message : string ,
0 commit comments