Interface DebugContextType

Combined debug context type with both state and action properties. Used by the legacy unified useDebug hook for backward compatibility.

Source

interface DebugContextType
  extends DebugStateContextValue,
    DebugActionsContextValue {}
interface DebugContextType {
    isDebugEnabled: boolean;
    debugMenuOpen: boolean;
    isStorageDebuggerEnabled: boolean;
    isLogViewerEnabled: boolean;
    isLogRedactionEnabled: boolean;
    isStateInspectorEnabled: boolean;
    stateInspectorSources: StateInspectorSourceSnapshot[];
    isIpcViewerEnabled: boolean;
    isEventLoggerEnabled: boolean;
    isConfidenceTestExporterEnabled: boolean;
    isPerformanceMonitorEnabled: boolean;
    performanceMetrics: PerformanceMetrics;
    currentFPS: number;
    eventLogEntries: DebugEventEntry[];
    maxEventLogEntries: number;
    ipcEvents: IpcLogEntry[];
    maxIpcEntries: number;
    logEntries: LogEntry[];
    maxLogEntries: number;
    toggleDebug: () => void;
    setDebugEnabled: (enabled: boolean) => void;
    openDebugMenu: () => void;
    closeDebugMenu: () => void;
    toggleDebugMenu: () => void;
    setIsStorageDebuggerEnabled: (enabled: boolean) => void;
    toggleStorageDebugger: () => void;
    setIsLogViewerEnabled: (enabled: boolean) => void;
    toggleLogViewer: () => void;
    setIsLogRedactionEnabled: (enabled: boolean) => void;
    toggleLogRedaction: () => void;
    setIsStateInspectorEnabled: (enabled: boolean) => void;
    toggleStateInspector: () => void;
    registerStateInspector: <T>(
        config: StateInspectorRegistration<T>,
    ) => StateInspectorHandle<T>;
    applyStateInspectorUpdate: (id: string, value: unknown) => void;
    refreshStateInspectorSource: (id: string) => void;
    setIsIpcViewerEnabled: (enabled: boolean) => void;
    toggleIpcViewer: () => void;
    setIsEventLoggerEnabled: (enabled: boolean) => void;
    toggleEventLogger: () => void;
    setIsConfidenceTestExporterEnabled: (enabled: boolean) => void;
    toggleConfidenceTestExporter: () => void;
    setIsPerformanceMonitorEnabled: (enabled: boolean) => void;
    togglePerformanceMonitor: () => void;
    recordApiLatency: (
        duration: number,
        success: boolean,
        correlationId?: string,
        provider?: string,
        endpoint?: string,
    ) => void;
    recordCacheAccess: (hit: boolean) => void;
    recordMatchingProgress: (
        current: number,
        total: number,
        elapsedMs: number,
    ) => void;
    updateMemoryStats: (stats: MemoryMetrics) => void;
    resetPerformanceMetrics: () => void;
    exportPerformanceReport: () => Promise<void>;
    recordEvent: (
        entry: DebugEventRecord,
        options?: RecordEventOptions,
    ) => void;
    clearEventLog: () => void;
    clearIpcEvents: () => void;
    clearLogs: () => void;
    exportLogs: () => Promise<void>;
}

Hierarchy (View Summary)

Properties

isDebugEnabled debugMenuOpen isStorageDebuggerEnabled isLogViewerEnabled isLogRedactionEnabled isStateInspectorEnabled stateInspectorSources isIpcViewerEnabled isEventLoggerEnabled isConfidenceTestExporterEnabled isPerformanceMonitorEnabled performanceMetrics currentFPS eventLogEntries maxEventLogEntries ipcEvents maxIpcEntries logEntries maxLogEntries toggleDebug setDebugEnabled openDebugMenu closeDebugMenu toggleDebugMenu setIsStorageDebuggerEnabled toggleStorageDebugger setIsLogViewerEnabled toggleLogViewer setIsLogRedactionEnabled toggleLogRedaction setIsStateInspectorEnabled toggleStateInspector registerStateInspector applyStateInspectorUpdate refreshStateInspectorSource setIsIpcViewerEnabled toggleIpcViewer setIsEventLoggerEnabled toggleEventLogger setIsConfidenceTestExporterEnabled toggleConfidenceTestExporter setIsPerformanceMonitorEnabled togglePerformanceMonitor recordApiLatency recordCacheAccess recordMatchingProgress updateMemoryStats resetPerformanceMetrics exportPerformanceReport recordEvent clearEventLog clearIpcEvents clearLogs exportLogs

Properties

isDebugEnabled

isDebugEnabled: boolean

Whether debug mode is currently enabled globally.

debugMenuOpen

debugMenuOpen: boolean

Whether the debug menu panel is visible.

isStorageDebuggerEnabled

isStorageDebuggerEnabled: boolean

Whether the storage inspector feature is enabled.

isLogViewerEnabled

isLogViewerEnabled: boolean

Whether console log interception and viewing is enabled.

isLogRedactionEnabled

isLogRedactionEnabled: boolean

Whether sensitive log content is redacted in logs.

isStateInspectorEnabled

isStateInspectorEnabled: boolean

Whether state inspection and time-travel debugging is enabled.

stateInspectorSources

stateInspectorSources: StateInspectorSourceSnapshot[]

Array of registered state inspector sources for inspection.

isIpcViewerEnabled

isIpcViewerEnabled: boolean

Whether IPC communication tracking is enabled.

isEventLoggerEnabled

isEventLoggerEnabled: boolean

Whether debug event logging is enabled.

isConfidenceTestExporterEnabled

isConfidenceTestExporterEnabled: boolean

Whether confidence test export feature is enabled.

isPerformanceMonitorEnabled

isPerformanceMonitorEnabled: boolean

Whether performance metrics collection is enabled.

performanceMetrics

performanceMetrics: PerformanceMetrics

Current performance metrics (API latency, cache stats, etc.).

currentFPS

currentFPS: number

eventLogEntries

eventLogEntries: DebugEventEntry[]

Array of recorded debug events.

maxEventLogEntries

maxEventLogEntries: number

Maximum number of event log entries retained.

ipcEvents

ipcEvents: IpcLogEntry[]

Array of tracked IPC communication events.

maxIpcEntries

maxIpcEntries: number

Maximum number of IPC entries retained.

logEntries

logEntries: LogEntry[]

Array of intercepted console log entries.

maxLogEntries

maxLogEntries: number

Maximum number of log entries retained.

toggleDebug

toggleDebug: () => void

Toggles debug mode between enabled/disabled.

setDebugEnabled

setDebugEnabled: (enabled: boolean) => void

Explicitly sets debug mode enabled/disabled state.

openDebugMenu

openDebugMenu: () => void

Opens the debug menu UI panel.

closeDebugMenu

closeDebugMenu: () => void

Closes the debug menu UI panel.

toggleDebugMenu

toggleDebugMenu: () => void

Toggles debug menu visibility.

setIsStorageDebuggerEnabled

setIsStorageDebuggerEnabled: (enabled: boolean) => void

Enables/disables storage inspector feature.

toggleStorageDebugger

toggleStorageDebugger: () => void

Toggles storage debugger feature.

setIsLogViewerEnabled

setIsLogViewerEnabled: (enabled: boolean) => void

Enables/disables console log interception and viewing.

toggleLogViewer

toggleLogViewer: () => void

Toggles log viewer feature.

setIsLogRedactionEnabled

setIsLogRedactionEnabled: (enabled: boolean) => void

Enables/disables log content redaction for sensitive data.

toggleLogRedaction

toggleLogRedaction: () => void

Toggles log redaction feature.

setIsStateInspectorEnabled

setIsStateInspectorEnabled: (enabled: boolean) => void

Enables/disables state inspection and time-travel debugging.

toggleStateInspector

toggleStateInspector: () => void

Toggles state inspector feature.

registerStateInspector

registerStateInspector: <T>(
    config: StateInspectorRegistration<T>,
) => StateInspectorHandle<T>

Registers a new state source for inspection.

applyStateInspectorUpdate

applyStateInspectorUpdate: (id: string, value: unknown) => void

Applies a state mutation via state inspector.

refreshStateInspectorSource

refreshStateInspectorSource: (id: string) => void

Manually refreshes a state inspector source snapshot.

setIsIpcViewerEnabled

setIsIpcViewerEnabled: (enabled: boolean) => void

Enables/disables IPC communication tracking.

toggleIpcViewer

toggleIpcViewer: () => void

Toggles IPC viewer feature.

setIsEventLoggerEnabled

setIsEventLoggerEnabled: (enabled: boolean) => void

Enables/disables debug event logging.

toggleEventLogger

toggleEventLogger: () => void

Toggles event logger feature.

setIsConfidenceTestExporterEnabled

setIsConfidenceTestExporterEnabled: (enabled: boolean) => void

Enables/disables confidence test export feature.

toggleConfidenceTestExporter

toggleConfidenceTestExporter: () => void

Toggles confidence test exporter feature.

setIsPerformanceMonitorEnabled

setIsPerformanceMonitorEnabled: (enabled: boolean) => void

Enables/disables performance metrics collection.

togglePerformanceMonitor

togglePerformanceMonitor: () => void

Toggles performance monitor feature.

recordApiLatency

recordApiLatency: (
    duration: number,
    success: boolean,
    correlationId?: string,
    provider?: string,
    endpoint?: string,
) => void

Records an API request latency sample.

recordCacheAccess

recordCacheAccess: (hit: boolean) => void

Records a cache hit or miss event.

recordMatchingProgress

recordMatchingProgress: (
    current: number,
    total: number,
    elapsedMs: number,
) => void

Records matching algorithm progress update.

updateMemoryStats

updateMemoryStats: (stats: MemoryMetrics) => void

Updates memory usage metrics.

resetPerformanceMetrics

resetPerformanceMetrics: () => void

Clears all performance metrics.

exportPerformanceReport

exportPerformanceReport: () => Promise<void>

Exports performance metrics to JSON file.

recordEvent

recordEvent: (entry: DebugEventRecord, options?: RecordEventOptions) => void

Records a debug event to the event log.

clearEventLog

clearEventLog: () => void

Clears all recorded debug events.

clearIpcEvents

clearIpcEvents: () => void

Clears all IPC communication events.

clearLogs

clearLogs: () => void

Clears all console log entries.

exportLogs

exportLogs: () => Promise<void>

Exports console logs to JSON file.

Settings

Member Visibility

On This Page

Properties
isDebugEnableddebugMenuOpenisStorageDebuggerEnabledisLogViewerEnabledisLogRedactionEnabledisStateInspectorEnabledstateInspectorSourcesisIpcViewerEnabledisEventLoggerEnabledisConfidenceTestExporterEnabledisPerformanceMonitorEnabledperformanceMetricscurrentFPSeventLogEntriesmaxEventLogEntriesipcEventsmaxIpcEntrieslogEntriesmaxLogEntriestoggleDebugsetDebugEnabledopenDebugMenucloseDebugMenutoggleDebugMenusetIsStorageDebuggerEnabledtoggleStorageDebuggersetIsLogViewerEnabledtoggleLogViewersetIsLogRedactionEnabledtoggleLogRedactionsetIsStateInspectorEnabledtoggleStateInspectorregisterStateInspectorapplyStateInspectorUpdaterefreshStateInspectorSourcesetIsIpcViewerEnabledtoggleIpcViewersetIsEventLoggerEnabledtoggleEventLoggersetIsConfidenceTestExporterEnabledtoggleConfidenceTestExportersetIsPerformanceMonitorEnabledtogglePerformanceMonitorrecordApiLatencyrecordCacheAccessrecordMatchingProgressupdateMemoryStatsresetPerformanceMetricsexportPerformanceReportrecordEventclearEventLogclearIpcEventsclearLogsexportLogs