Skip to main content

Interface: ExtractIpcResponseDataOptions<T>

Defined in: shared/utils/ipcResponse.ts:45

Options for extractIpcResponseData.

Type Parameters​

T​

T = unknown

Properties​

parse()?​

readonly optional parse: (data: unknown) => T

Defined in: shared/utils/ipcResponse.ts:54

Optional payload parser/validator.

Parameters​

data​

unknown

Returns​

T

Remarks​

When provided, the parser is used to convert/validate the raw data payload. This makes the extractor genuinely type-safe and also allows TypeScript to infer T from the parser.

requireData?​

readonly optional requireData: boolean

Defined in: shared/utils/ipcResponse.ts:70

When true, success: true responses must include a defined data payload.

Remarks​

Typed preload invokers expect main-process handlers to always include a payload (even if it is null). A missing payload usually indicates a handler bug.

Some channels may intentionally return undefined (e.g. "optional" lookups). Those callers should set this to false.

Default Value​

true;