Skip to main content

Function: registerStandardizedIpcHandler()

function registerStandardizedIpcHandler<TChannel>(
    channelName: TChannel,
    handler: StrictIpcInvokeHandler<TChannel>,
    validateParams: IpcParameterValidator | null,
    registeredHandlers: Set<keyof IpcInvokeChannelMap>,
    validateResult?: IpcResultValidator<IpcInvokeChannelResult<TChannel>> | null
): void;

Defined in: electron/services/ipc/utils.ts:483

Registers a standardized IPC handler with consistent error handling and response formatting.

Type Parameters​

TChannel​

TChannel extends keyof IpcInvokeChannelMap

Parameters​

channelName​

TChannel

Name of the IPC channel

handler​

StrictIpcInvokeHandler<TChannel>

The handler function

validateParams​

| IpcParameterValidator | null

Optional parameter validation function

registeredHandlers​

Set<keyof IpcInvokeChannelMap>

Set to track registered handlers for cleanup

validateResult?​

| IpcResultValidator<IpcInvokeChannelResult<TChannel>> | null

Optional validator for successful handler results

Returns​

void

Remarks​

Registers an IPC handler with the electron ipcMain, automatically wrapping it with standardized error handling, logging, and response formatting. All responses will follow the IpcResponse interface for consistency.

Example​

import { SITES_CHANNELS } from "@shared/types/preload";

registerStandardizedIpcHandler(
    SITES_CHANNELS.getSites,
    async () => this.uptimeOrchestrator.getSites(),
    null,
    this.registeredIpcHandlers
);