Skip to main content

Function: extractIpcResponseData()

extractIpcResponseData<T>(response: unknown, options: ExtractIpcResponseDataOptions<T>): T

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

Extracts data from a successful IpcResponse envelope.

Type Parametersโ€‹

Tโ€‹

T

Parametersโ€‹

responseโ€‹

unknown

optionsโ€‹

ExtractIpcResponseDataOptions<T> = {}

Returnsโ€‹

T

Remarksโ€‹

Throws for invalid envelopes.

  • Throws for success: false envelopes.
  • Does not require data to be present. A successful response may legitimately omit data (e.g. T includes undefined).