Skip to main content

Function: getMonitorWithResult()

getMonitorWithResult(type: "http" | "port" | "ping" | "dns", config?: MonitorConfig, forceConfigUpdate?: boolean): MonitorServiceResult

Defined in: electron/services/monitoring/MonitorFactory.ts:161

Retrieves the monitor service instance with configuration application status.

Parameters​

type​

The monitor type string. Must be a valid registered type.

"http" | "port" | "ping" | "dns"

config?​

MonitorConfig

Optional monitor configuration to apply to the instance.

forceConfigUpdate?​

boolean = false

If true, updates the configuration on an existing instance even if already set.

Returns​

MonitorServiceResult

Result object containing the service instance and configuration status.

Remarks​

Same as getMonitor but returns detailed result including configuration application status. Use this method when you need to know if configuration was successfully applied.

Example​

const result = getMonitorWithResult("http", { timeout: 5000 });
if (!result.configurationApplied && result.configurationError) {
    console.warn("Config failed:", result.configurationError);
}

Throws​

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error If the monitor type is not supported or no service factory is registered for the type.