Skip to main content

Interface: IpcResponse<T>

Defined in: shared/types/ipc.ts:54

Standardized IPC response envelope shared across renderer, preload, and main.

Type Parametersโ€‹

Tโ€‹

T = unknown

Propertiesโ€‹

data?โ€‹

optional data?: T;

Defined in: shared/types/ipc.ts:56

Response data returned on success.


error?โ€‹

optional error?: string;

Defined in: shared/types/ipc.ts:58

Error message when the handler fails.


metadata?โ€‹

optional metadata?: UnknownRecord;

Defined in: shared/types/ipc.ts:60

Optional metadata emitted by the handler.


successโ€‹

success: boolean;

Defined in: shared/types/ipc.ts:62

Indicates whether the IPC call succeeded.


warnings?โ€‹

optional warnings?: readonly string[];

Defined in: shared/types/ipc.ts:64

Optional non-fatal warnings emitted alongside the result.