Skip to main content

Interface: GuardedIpcServiceHelpers

Defined in: src/services/utils/createIpcServiceHelpers.ts:129

Typed wrapper utilities for building guarded IPC services.

Remarks​

Returned by createIpcServiceHelpers and getIpcServiceHelpers. Consumers typically spread these helpers into service objects exposed from src/services.

Properties​

ensureInitialized()​

ensureInitialized: () => Promise<void>

Defined in: src/services/utils/createIpcServiceHelpers.ts:131

Ensures the preload bridge is ready before IPC calls.

Returns​

Promise<void>

wrap()​

wrap: <Args, Result>(methodName: string, handler: (api: ElectronAPI, ...args: Args) => Promise<Result>) => (...args: Args) => Promise<Result>

Defined in: src/services/utils/createIpcServiceHelpers.ts:136

Wraps a handler so it automatically waits for initialization and logs failures using a consistent format.

Type Parameters​

Args​

Args extends unknown[]

Result​

Result

Parameters​

methodName​

string

handler​

(api: ElectronAPI, ...args: Args) => Promise<Result>

Returns​

(...args: Args): Promise<Result>

Parameters​
args​

...Args

Returns​

Promise<Result>