Skip to main content

Interface: IpcHandlerMetadata

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

Structured metadata describing IPC handler execution characteristics.

Remarks

This type intentionally extends UnknownRecord so additional diagnostic fields can be attached without weakening the metadata contract for known properties like handler, duration, and paramCount. Callers outside this module should continue to treat the public IpcResponse.metadata field as an opaque record.

Hierarchy

View Summary

Extends

  • UnknownRecord

Indexable

[key: string]: unknown
[key: number]: unknown
[key: symbol]: unknown

Properties

correlationId?

optional correlationId?: CorrelationId;

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

Correlation identifier propagated from the renderer.


duration?

optional duration?: number;

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

Total handler execution duration in milliseconds.


handler?

optional handler?: string;

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

Fully-qualified IPC handler name (channel identifier).


paramCount?

optional paramCount?: number;

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

Number of parameters supplied to the handler.


resultValidationErrors?

optional resultValidationErrors?: readonly string[];

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

Optional validation errors when the success payload validation fails.


validationErrors?

optional validationErrors?: readonly string[];

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

Optional validation errors when parameter validation fails.